0308315afe1e89585f651d97f4d8c368473afc78
[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":{}};
21 </script>
22
23
24
25 </head>
26 <body>
27 <div id="wrap" class="clearfix">
28
29 <div class="navigation">
30 <h3 class="applicationName"><a href="index.html"></a></h3>
31
32 <div class="search">
33 <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
34 </div>
35 <ul class="list">
36
37 <li class="item" data-name="LuCI">
38 <span class="title">
39 <a href="LuCI.html">LuCI</a>
40
41 </span>
42 <ul class="members itemMembers">
43
44 <span class="subtitle">Members</span>
45
46 <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
47
48 </ul>
49 <ul class="typedefs itemMembers">
50
51 <span class="subtitle">Typedefs</span>
52
53 <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
54
55 </ul>
56 <ul class="typedefs itemMembers">
57
58 </ul>
59 <ul class="methods itemMembers">
60
61 <span class="subtitle">Methods</span>
62
63 <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
64
65 <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
66
67 <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
68
69 <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
70
71 <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
72
73 <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
74
75 <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
76
77 <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
78
79 <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
80
81 <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
82
83 <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
84
85 <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
86
87 <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
88
89 <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
90
91 <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
92
93 <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
94
95 <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
96
97 <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
98
99 <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
100
101 </ul>
102 <ul class="events itemMembers">
103
104 </ul>
105 </li>
106
107 <li class="item" data-name="LuCI.Class">
108 <span class="title">
109 <a href="LuCI.Class.html">LuCI.Class</a>
110
111 </span>
112 <ul class="members itemMembers">
113
114 </ul>
115 <ul class="typedefs itemMembers">
116
117 </ul>
118 <ul class="typedefs itemMembers">
119
120 </ul>
121 <ul class="methods itemMembers">
122
123 <span class="subtitle">Methods</span>
124
125 <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
126
127 <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
128
129 <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
130
131 <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
132
133 <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
134
135 <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
136
137 </ul>
138 <ul class="events itemMembers">
139
140 </ul>
141 </li>
142
143 <li class="item" data-name="LuCI.dom">
144 <span class="title">
145 <a href="LuCI.dom.html">LuCI.dom</a>
146
147 </span>
148 <ul class="members itemMembers">
149
150 </ul>
151 <ul class="typedefs itemMembers">
152
153 <span class="subtitle">Typedefs</span>
154
155 <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
156
157 </ul>
158 <ul class="typedefs itemMembers">
159
160 </ul>
161 <ul class="methods itemMembers">
162
163 <span class="subtitle">Methods</span>
164
165 <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
166
167 <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
168
169 <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
170
171 <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
172
173 <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
174
175 <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
176
177 <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
178
179 <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
180
181 <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
182
183 <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
184
185 <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
186
187 <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
188
189 <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
190
191 </ul>
192 <ul class="events itemMembers">
193
194 </ul>
195 </li>
196
197 <li class="item" data-name="LuCI.fs">
198 <span class="title">
199 <a href="LuCI.fs.html">LuCI.fs</a>
200
201 </span>
202 <ul class="members itemMembers">
203
204 </ul>
205 <ul class="typedefs itemMembers">
206
207 <span class="subtitle">Typedefs</span>
208
209 <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
210
211 <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
212
213 </ul>
214 <ul class="typedefs itemMembers">
215
216 </ul>
217 <ul class="methods itemMembers">
218
219 <span class="subtitle">Methods</span>
220
221 <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
222
223 <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
224
225 <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
226
227 <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
228
229 <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
230
231 <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
232
233 <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
234
235 <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
236
237 </ul>
238 <ul class="events itemMembers">
239
240 </ul>
241 </li>
242
243 <li class="item" data-name="LuCI.Headers">
244 <span class="title">
245 <a href="LuCI.Headers.html">LuCI.Headers</a>
246
247 </span>
248 <ul class="members itemMembers">
249
250 </ul>
251 <ul class="typedefs itemMembers">
252
253 </ul>
254 <ul class="typedefs itemMembers">
255
256 </ul>
257 <ul class="methods itemMembers">
258
259 <span class="subtitle">Methods</span>
260
261 <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
262
263 <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
264
265 </ul>
266 <ul class="events itemMembers">
267
268 </ul>
269 </li>
270
271 <li class="item" data-name="LuCI.Network">
272 <span class="title">
273 <a href="LuCI.Network.html">LuCI.Network</a>
274
275 </span>
276 <ul class="members itemMembers">
277
278 </ul>
279 <ul class="typedefs itemMembers">
280
281 <span class="subtitle">Typedefs</span>
282
283 <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
284
285 <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
286
287 <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
288
289 <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
290
291 <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
292
293 </ul>
294 <ul class="typedefs itemMembers">
295
296 </ul>
297 <ul class="methods itemMembers">
298
299 <span class="subtitle">Methods</span>
300
301 <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
302
303 <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
304
305 <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
306
307 <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
308
309 <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
310
311 <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
312
313 <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
314
315 <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
316
317 <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
318
319 <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
320
321 <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
322
323 <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
324
325 <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
326
327 <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
328
329 <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
330
331 <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
332
333 <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
334
335 <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
336
337 <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
338
339 <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
340
341 <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
342
343 <li data-name="LuCI.Network#getWifiNetworks"><a href="LuCI.Network.html#getWifiNetworks">getWifiNetworks</a></li>
344
345 <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
346
347 <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
348
349 <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
350
351 <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
352
353 <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
354
355 <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
356
357 <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
358
359 </ul>
360 <ul class="events itemMembers">
361
362 </ul>
363 </li>
364
365 <li class="item" data-name="LuCI.Network.Device">
366 <span class="title">
367 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
368
369 </span>
370 <ul class="members itemMembers">
371
372 </ul>
373 <ul class="typedefs itemMembers">
374
375 </ul>
376 <ul class="typedefs itemMembers">
377
378 </ul>
379 <ul class="methods itemMembers">
380
381 <span class="subtitle">Methods</span>
382
383 <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
384
385 <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
386
387 <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
388
389 <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
390
391 <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
392
393 <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
394
395 <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
396
397 <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
398
399 <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
400
401 <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
402
403 <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
404
405 <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
406
407 <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
408
409 <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
410
411 <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
412
413 <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
414
415 <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
416
417 <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
418
419 <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
420
421 <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
422
423 <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
424
425 <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
426
427 </ul>
428 <ul class="events itemMembers">
429
430 </ul>
431 </li>
432
433 <li class="item" data-name="LuCI.Network.Hosts">
434 <span class="title">
435 <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
436
437 </span>
438 <ul class="members itemMembers">
439
440 </ul>
441 <ul class="typedefs itemMembers">
442
443 </ul>
444 <ul class="typedefs itemMembers">
445
446 </ul>
447 <ul class="methods itemMembers">
448
449 <span class="subtitle">Methods</span>
450
451 <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
452
453 <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
454
455 <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
456
457 <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
458
459 <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
460
461 <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
462
463 <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
464
465 <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
466
467 </ul>
468 <ul class="events itemMembers">
469
470 </ul>
471 </li>
472
473 <li class="item" data-name="LuCI.Network.Protocol">
474 <span class="title">
475 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
476
477 </span>
478 <ul class="members itemMembers">
479
480 </ul>
481 <ul class="typedefs itemMembers">
482
483 </ul>
484 <ul class="typedefs itemMembers">
485
486 </ul>
487 <ul class="methods itemMembers">
488
489 <span class="subtitle">Methods</span>
490
491 <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
492
493 <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
494
495 <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
496
497 <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
498
499 <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
500
501 <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
502
503 <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
504
505 <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
506
507 <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
508
509 <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
510
511 <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
512
513 <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
514
515 <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
516
517 <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
518
519 <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
520
521 <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
522
523 <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
524
525 <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
526
527 <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
528
529 <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
530
531 <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
532
533 <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
534
535 <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
536
537 <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
538
539 <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
540
541 <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
542
543 <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
544
545 <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
546
547 <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
548
549 <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
550
551 <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
552
553 <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
554
555 <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
556
557 <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
558
559 <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
560
561 <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
562
563 <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
564
565 <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
566
567 </ul>
568 <ul class="events itemMembers">
569
570 </ul>
571 </li>
572
573 <li class="item" data-name="LuCI.Network.WifiDevice">
574 <span class="title">
575 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
576
577 </span>
578 <ul class="members itemMembers">
579
580 </ul>
581 <ul class="typedefs itemMembers">
582
583 </ul>
584 <ul class="typedefs itemMembers">
585
586 </ul>
587 <ul class="methods itemMembers">
588
589 <span class="subtitle">Methods</span>
590
591 <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
592
593 <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
594
595 <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
596
597 <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
598
599 <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
600
601 <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
602
603 <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
604
605 <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
606
607 <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
608
609 <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
610
611 <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
612
613 <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
614
615 <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
616
617 </ul>
618 <ul class="events itemMembers">
619
620 </ul>
621 </li>
622
623 <li class="item" data-name="LuCI.Network.WifiNetwork">
624 <span class="title">
625 <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
626
627 </span>
628 <ul class="members itemMembers">
629
630 </ul>
631 <ul class="typedefs itemMembers">
632
633 </ul>
634 <ul class="typedefs itemMembers">
635
636 </ul>
637 <ul class="methods itemMembers">
638
639 <span class="subtitle">Methods</span>
640
641 <li data-name="LuCI.Network.WifiNetwork#disconnectClient"><a href="LuCI.Network.WifiNetwork.html#disconnectClient">disconnectClient</a></li>
642
643 <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
644
645 <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
646
647 <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
648
649 <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
650
651 <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
652
653 <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
654
655 <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
656
657 <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
658
659 <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
660
661 <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
662
663 <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
664
665 <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
666
667 <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
668
669 <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
670
671 <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
672
673 <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
674
675 <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
676
677 <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
678
679 <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
680
681 <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
682
683 <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
684
685 <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
686
687 <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
688
689 <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
690
691 <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
692
693 <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
694
695 <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
696
697 <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
698
699 <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
700
701 <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
702
703 <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
704
705 <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
706
707 <li data-name="LuCI.Network.WifiNetwork#isClientDisconnectSupported"><a href="LuCI.Network.WifiNetwork.html#isClientDisconnectSupported">isClientDisconnectSupported</a></li>
708
709 <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
710
711 <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
712
713 <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
714
715 </ul>
716 <ul class="events itemMembers">
717
718 </ul>
719 </li>
720
721 <li class="item" data-name="LuCI.Poll">
722 <span class="title">
723 <a href="LuCI.Poll.html">LuCI.Poll</a>
724
725 </span>
726 <ul class="members itemMembers">
727
728 </ul>
729 <ul class="typedefs itemMembers">
730
731 </ul>
732 <ul class="typedefs itemMembers">
733
734 </ul>
735 <ul class="methods itemMembers">
736
737 <span class="subtitle">Methods</span>
738
739 <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
740
741 <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
742
743 <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
744
745 <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
746
747 <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
748
749 </ul>
750 <ul class="events itemMembers">
751
752 </ul>
753 </li>
754
755 <li class="item" data-name="LuCI.Request">
756 <span class="title">
757 <a href="LuCI.Request.html">LuCI.Request</a>
758
759 </span>
760 <ul class="members itemMembers">
761
762 </ul>
763 <ul class="typedefs itemMembers">
764
765 <span class="subtitle">Typedefs</span>
766
767 <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
768
769 <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
770
771 </ul>
772 <ul class="typedefs itemMembers">
773
774 </ul>
775 <ul class="methods itemMembers">
776
777 <span class="subtitle">Methods</span>
778
779 <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
780
781 <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
782
783 <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
784
785 <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
786
787 <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
788
789 <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
790
791 </ul>
792 <ul class="events itemMembers">
793
794 </ul>
795 </li>
796
797 <li class="item" data-name="LuCI.Request.poll">
798 <span class="title">
799 <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
800
801 </span>
802 <ul class="members itemMembers">
803
804 </ul>
805 <ul class="typedefs itemMembers">
806
807 <span class="subtitle">Typedefs</span>
808
809 <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
810
811 </ul>
812 <ul class="typedefs itemMembers">
813
814 </ul>
815 <ul class="methods itemMembers">
816
817 <span class="subtitle">Methods</span>
818
819 <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
820
821 <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
822
823 <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
824
825 <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
826
827 <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
828
829 </ul>
830 <ul class="events itemMembers">
831
832 </ul>
833 </li>
834
835 <li class="item" data-name="LuCI.Response">
836 <span class="title">
837 <a href="LuCI.Response.html">LuCI.Response</a>
838
839 </span>
840 <ul class="members itemMembers">
841
842 <span class="subtitle">Members</span>
843
844 <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
845
846 <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
847
848 <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
849
850 <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
851
852 <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
853
854 <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
855
856 </ul>
857 <ul class="typedefs itemMembers">
858
859 </ul>
860 <ul class="typedefs itemMembers">
861
862 </ul>
863 <ul class="methods itemMembers">
864
865 <span class="subtitle">Methods</span>
866
867 <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
868
869 <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
870
871 <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
872
873 </ul>
874 <ul class="events itemMembers">
875
876 </ul>
877 </li>
878
879 <li class="item" data-name="LuCI.rpc">
880 <span class="title">
881 <a href="LuCI.rpc.html">LuCI.rpc</a>
882
883 </span>
884 <ul class="members itemMembers">
885
886 </ul>
887 <ul class="typedefs itemMembers">
888
889 <span class="subtitle">Typedefs</span>
890
891 <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
892
893 <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
894
895 <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
896
897 <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
898
899 </ul>
900 <ul class="typedefs itemMembers">
901
902 </ul>
903 <ul class="methods itemMembers">
904
905 <span class="subtitle">Methods</span>
906
907 <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
908
909 <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
910
911 <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
912
913 <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
914
915 <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
916
917 <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
918
919 <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
920
921 <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
922
923 <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
924
925 </ul>
926 <ul class="events itemMembers">
927
928 </ul>
929 </li>
930
931 <li class="item" data-name="LuCI.uci">
932 <span class="title">
933 <a href="LuCI.uci.html">LuCI.uci</a>
934
935 </span>
936 <ul class="members itemMembers">
937
938 </ul>
939 <ul class="typedefs itemMembers">
940
941 <span class="subtitle">Typedefs</span>
942
943 <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
944
945 <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
946
947 <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
948
949 </ul>
950 <ul class="typedefs itemMembers">
951
952 </ul>
953 <ul class="methods itemMembers">
954
955 <span class="subtitle">Methods</span>
956
957 <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
958
959 <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
960
961 <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
962
963 <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
964
965 <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
966
967 <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
968
969 <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
970
971 <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
972
973 <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
974
975 <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
976
977 <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
978
979 <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
980
981 <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
982
983 <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
984
985 <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
986
987 <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
988
989 <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
990
991 </ul>
992 <ul class="events itemMembers">
993
994 </ul>
995 </li>
996
997 <li class="item" data-name="LuCI.view">
998 <span class="title">
999 <a href="LuCI.view.html">LuCI.view</a>
1000
1001 </span>
1002 <ul class="members itemMembers">
1003
1004 </ul>
1005 <ul class="typedefs itemMembers">
1006
1007 </ul>
1008 <ul class="typedefs itemMembers">
1009
1010 </ul>
1011 <ul class="methods itemMembers">
1012
1013 <span class="subtitle">Methods</span>
1014
1015 <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
1016
1017 <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
1018
1019 <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
1020
1021 <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
1022
1023 <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
1024
1025 <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
1026
1027 </ul>
1028 <ul class="events itemMembers">
1029
1030 </ul>
1031 </li>
1032
1033 <li class="item" data-name="LuCI.XHR">
1034 <span class="title">
1035 <a href="LuCI.XHR.html">LuCI.XHR</a>
1036
1037 </span>
1038 <ul class="members itemMembers">
1039
1040 </ul>
1041 <ul class="typedefs itemMembers">
1042
1043 </ul>
1044 <ul class="typedefs itemMembers">
1045
1046 </ul>
1047 <ul class="methods itemMembers">
1048
1049 <span class="subtitle">Methods</span>
1050
1051 <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
1052
1053 <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
1054
1055 <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
1056
1057 <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
1058
1059 <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
1060
1061 <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
1062
1063 </ul>
1064 <ul class="events itemMembers">
1065
1066 </ul>
1067 </li>
1068
1069 </ul>
1070 </div>
1071 <div class="main">
1072 <h1 class="page-title" data-filename="LuCI.Network.WifiNetwork.html">Class: WifiNetwork</h1>
1073
1074
1075
1076
1077 <section>
1078
1079 <header>
1080 <h2>
1081 <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>
1082
1083 WifiNetwork
1084 </h2>
1085
1086 <div class="class-description"><p>A <code>Network.WifiNetwork</code> instance represents a wireless network (vif)
1087 configured on top of a radio device and provides functions for querying
1088 the runtime state of the network. Most radio devices support multiple
1089 such networks in parallel.</p></div>
1090
1091 </header>
1092
1093 <article>
1094 <div class="container-overview">
1095
1096
1097
1098
1099 <dt>
1100 <div class="nameContainer">
1101 <h4 class="name" id="WifiNetwork">
1102
1103 new LuCI.Network.WifiNetwork<span class="signature">()</span>
1104 </h4>
1105
1106
1107 <div class="tag-source">
1108 network.js, line 3337
1109 </div>
1110
1111 </div>
1112
1113
1114 </dt>
1115 <dd>
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126 <dl class="details">
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148 </dl>
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162 </dd>
1163
1164
1165 </div>
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180 <h3 class="subsection-title">Methods</h3>
1181
1182 <dl>
1183
1184 <dt>
1185 <div class="nameContainer">
1186 <h4 class="name" id="disconnectClient">
1187
1188 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>
1189 </h4>
1190
1191
1192 <div class="tag-source">
1193 network.js, line 4080
1194 </div>
1195
1196 </div>
1197
1198
1199 </dt>
1200 <dd>
1201
1202
1203 <div class="description">
1204 <p>Forcibly disconnect the given client from the wireless network.</p>
1205 </div>
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215 <table class="params">
1216 <thead>
1217 <tr>
1218
1219 <th>Name</th>
1220
1221
1222 <th>Type</th>
1223
1224
1225 <th>Default</th>
1226
1227
1228 <th class="last">Description</th>
1229 </tr>
1230 </thead>
1231
1232 <tbody>
1233
1234
1235 <tr>
1236
1237 <td class="name"><code>mac</code></td>
1238
1239
1240 <td class="type">
1241
1242
1243 <span class="param-type">string</span>
1244
1245
1246
1247 </td>
1248
1249
1250 <td class="default">
1251
1252 </td>
1253
1254
1255 <td class="description last">
1256
1257
1258
1259
1260
1261
1262 <p>The MAC address of the client to disconnect.</p></td>
1263 </tr>
1264
1265
1266
1267 <tr>
1268
1269 <td class="name"><code>deauth</code></td>
1270
1271
1272 <td class="type">
1273
1274
1275 <span class="param-type">boolean</span>
1276
1277
1278
1279 </td>
1280
1281
1282 <td class="default">
1283
1284 false
1285
1286 </td>
1287
1288
1289 <td class="description last">
1290
1291
1292 <span class="optional">optional</span>
1293
1294
1295
1296
1297
1298 <p>Specifies whether to deauthenticate (<code>true</code>) or disassociate (<code>false</code>)
1299 the client.</p></td>
1300 </tr>
1301
1302
1303
1304 <tr>
1305
1306 <td class="name"><code>reason</code></td>
1307
1308
1309 <td class="type">
1310
1311
1312 <span class="param-type">number</span>
1313
1314
1315
1316 </td>
1317
1318
1319 <td class="default">
1320
1321 1
1322
1323 </td>
1324
1325
1326 <td class="description last">
1327
1328
1329 <span class="optional">optional</span>
1330
1331
1332
1333
1334
1335 <p>Specifies the IEEE 802.11 reason code to disassoc/deauth the client
1336 with. Default is <code>1</code> which corresponds to <code>Unspecified reason</code>.</p></td>
1337 </tr>
1338
1339
1340
1341 <tr>
1342
1343 <td class="name"><code>ban_time</code></td>
1344
1345
1346 <td class="type">
1347
1348
1349 <span class="param-type">number</span>
1350
1351
1352
1353 </td>
1354
1355
1356 <td class="default">
1357
1358 0
1359
1360 </td>
1361
1362
1363 <td class="description last">
1364
1365
1366 <span class="optional">optional</span>
1367
1368
1369
1370
1371
1372 <p>Specifies the amount of milliseconds to ban the client from
1373 reconnecting. By default, no ban time is set which allows the client
1374 to reassociate / reauthenticate immediately.</p></td>
1375 </tr>
1376
1377
1378 </tbody>
1379 </table>
1380
1381
1382
1383 <dl class="details">
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405 </dl>
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417 <h5>Returns:</h5>
1418
1419
1420
1421 <table class="params">
1422 <thead>
1423 <tr>
1424
1425 <th>Type</th>
1426 <th class="last">Description</th>
1427 </tr>
1428 </thead>
1429 <tbody>
1430
1431 <tr>
1432
1433 <td class="type">
1434
1435 Promise.&lt;number>
1436
1437
1438 </td>
1439 <td class="description last">Returns a promise resolving to the underlying ubus call result code
1440 which is typically <code>0</code>, even for not existing MAC addresses.
1441 The promise might reject with an error in case invalid arguments
1442 are passed.</td>
1443 </tr>
1444
1445 </tbody>
1446 </table>
1447
1448
1449
1450
1451 </dd>
1452
1453
1454
1455 <dt>
1456 <div class="nameContainer">
1457 <h4 class="name" id="get">
1458
1459 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>
1460 </h4>
1461
1462
1463 <div class="tag-source">
1464 network.js, line 3371
1465 </div>
1466
1467 </div>
1468
1469
1470 </dt>
1471 <dd>
1472
1473
1474 <div class="description">
1475 <p>Read the given UCI option value of this wireless network.</p>
1476 </div>
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486 <table class="params">
1487 <thead>
1488 <tr>
1489
1490 <th>Name</th>
1491
1492
1493 <th>Type</th>
1494
1495
1496
1497 <th class="last">Description</th>
1498 </tr>
1499 </thead>
1500
1501 <tbody>
1502
1503
1504 <tr>
1505
1506 <td class="name"><code>opt</code></td>
1507
1508
1509 <td class="type">
1510
1511
1512 <span class="param-type">string</span>
1513
1514
1515
1516 </td>
1517
1518
1519
1520 <td class="description last">
1521
1522 <p>The UCI option name to read.</p></td>
1523 </tr>
1524
1525
1526 </tbody>
1527 </table>
1528
1529
1530
1531 <dl class="details">
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553 </dl>
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565 <h5>Returns:</h5>
1566
1567
1568
1569 <table class="params">
1570 <thead>
1571 <tr>
1572
1573 <th>Type</th>
1574 <th class="last">Description</th>
1575 </tr>
1576 </thead>
1577 <tbody>
1578
1579 <tr>
1580
1581 <td class="type">
1582
1583 null
1584 |
1585
1586 string
1587 |
1588
1589 Array.&lt;string>
1590
1591
1592 </td>
1593 <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is
1594 not found.</td>
1595 </tr>
1596
1597 </tbody>
1598 </table>
1599
1600
1601
1602
1603 </dd>
1604
1605
1606
1607 <dt>
1608 <div class="nameContainer">
1609 <h4 class="name" id="getActiveBSSID">
1610
1611 getActiveBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1612 </h4>
1613
1614
1615 <div class="tag-source">
1616 network.js, line 3624
1617 </div>
1618
1619 </div>
1620
1621
1622 </dt>
1623 <dd>
1624
1625
1626 <div class="description">
1627 <p>Query the current BSSID from runtime information.</p>
1628 </div>
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638 <dl class="details">
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660 </dl>
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672 <h5>Returns:</h5>
1673
1674
1675
1676 <table class="params">
1677 <thead>
1678 <tr>
1679
1680 <th>Type</th>
1681 <th class="last">Description</th>
1682 </tr>
1683 </thead>
1684 <tbody>
1685
1686 <tr>
1687
1688 <td class="type">
1689
1690 string
1691
1692
1693 </td>
1694 <td class="description last">Returns the current BSSID or Mesh ID as reported by <code>ubus</code> runtime
1695 information.</td>
1696 </tr>
1697
1698 </tbody>
1699 </table>
1700
1701
1702
1703
1704 </dd>
1705
1706
1707
1708 <dt>
1709 <div class="nameContainer">
1710 <h4 class="name" id="getActiveEncryption">
1711
1712 getActiveEncryption<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1713 </h4>
1714
1715
1716 <div class="tag-source">
1717 network.js, line 3635
1718 </div>
1719
1720 </div>
1721
1722
1723 </dt>
1724 <dd>
1725
1726
1727 <div class="description">
1728 <p>Query the current encryption settings from runtime information.</p>
1729 </div>
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739 <dl class="details">
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761 </dl>
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773 <h5>Returns:</h5>
1774
1775
1776
1777 <table class="params">
1778 <thead>
1779 <tr>
1780
1781 <th>Type</th>
1782 <th class="last">Description</th>
1783 </tr>
1784 </thead>
1785 <tbody>
1786
1787 <tr>
1788
1789 <td class="type">
1790
1791 string
1792
1793
1794 </td>
1795 <td class="description last">Returns a string describing the current encryption or <code>-</code> if the the
1796 encryption state could not be found in <code>ubus</code> runtime information.</td>
1797 </tr>
1798
1799 </tbody>
1800 </table>
1801
1802
1803
1804
1805 </dd>
1806
1807
1808
1809 <dt>
1810 <div class="nameContainer">
1811 <h4 class="name" id="getActiveMode">
1812
1813 getActiveMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1814 </h4>
1815
1816
1817 <div class="tag-source">
1818 network.js, line 3572
1819 </div>
1820
1821 </div>
1822
1823
1824 </dt>
1825 <dd>
1826
1827
1828 <div class="description">
1829 <p>Query the current operation mode from runtime information.</p>
1830 </div>
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840 <dl class="details">
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862 </dl>
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874 <h5>Returns:</h5>
1875
1876
1877
1878 <table class="params">
1879 <thead>
1880 <tr>
1881
1882 <th>Type</th>
1883 <th class="last">Description</th>
1884 </tr>
1885 </thead>
1886 <tbody>
1887
1888 <tr>
1889
1890 <td class="type">
1891
1892 string
1893
1894
1895 </td>
1896 <td class="description last">Returns the human readable mode name as reported by <code>ubus</code> runtime
1897 state. Possible returned values are:
1898 <ul>
1899 <li><code>Master</code></li>
1900 <li><code>Ad-Hoc</code></li>
1901 <li><code>Client</code></li>
1902 <li><code>Monitor</code></li>
1903 <li><code>Master (VLAN)</code></li>
1904 <li><code>WDS</code></li>
1905 <li><code>Mesh Point</code></li>
1906 <li><code>P2P Client</code></li>
1907 <li><code>P2P Go</code></li>
1908 <li><code>Unknown</code></li>
1909 </ul></td>
1910 </tr>
1911
1912 </tbody>
1913 </table>
1914
1915
1916
1917
1918 </dd>
1919
1920
1921
1922 <dt>
1923 <div class="nameContainer">
1924 <h4 class="name" id="getActiveModeI18n">
1925
1926 getActiveModeI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
1927 </h4>
1928
1929
1930 <div class="tag-source">
1931 network.js, line 3593
1932 </div>
1933
1934 </div>
1935
1936
1937 </dt>
1938 <dd>
1939
1940
1941 <div class="description">
1942 <p>Query the current operation mode from runtime information as
1943 translated string.</p>
1944 </div>
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954 <dl class="details">
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976 </dl>
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988 <h5>Returns:</h5>
1989
1990
1991
1992 <table class="params">
1993 <thead>
1994 <tr>
1995
1996 <th>Type</th>
1997 <th class="last">Description</th>
1998 </tr>
1999 </thead>
2000 <tbody>
2001
2002 <tr>
2003
2004 <td class="type">
2005
2006 string
2007
2008
2009 </td>
2010 <td class="description last">Returns the translated, human readable mode name as reported by
2011 <code>ubus</code> runtime state.</td>
2012 </tr>
2013
2014 </tbody>
2015 </table>
2016
2017
2018
2019
2020 </dd>
2021
2022
2023
2024 <dt>
2025 <div class="nameContainer">
2026 <h4 class="name" id="getActiveSSID">
2027
2028 getActiveSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2029 </h4>
2030
2031
2032 <div class="tag-source">
2033 network.js, line 3613
2034 </div>
2035
2036 </div>
2037
2038
2039 </dt>
2040 <dd>
2041
2042
2043 <div class="description">
2044 <p>Query the current SSID from runtime information.</p>
2045 </div>
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055 <dl class="details">
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077 </dl>
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089 <h5>Returns:</h5>
2090
2091
2092
2093 <table class="params">
2094 <thead>
2095 <tr>
2096
2097 <th>Type</th>
2098 <th class="last">Description</th>
2099 </tr>
2100 </thead>
2101 <tbody>
2102
2103 <tr>
2104
2105 <td class="type">
2106
2107 string
2108
2109
2110 </td>
2111 <td class="description last">Returns the current SSID or Mesh ID as reported by <code>ubus</code> runtime
2112 information.</td>
2113 </tr>
2114
2115 </tbody>
2116 </table>
2117
2118
2119
2120
2121 </dd>
2122
2123
2124
2125 <dt>
2126 <div class="nameContainer">
2127 <h4 class="name" id="getAssocList">
2128
2129 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>
2130 </h4>
2131
2132
2133 <div class="tag-source">
2134 network.js, line 3815
2135 </div>
2136
2137 </div>
2138
2139
2140 </dt>
2141 <dd>
2142
2143
2144 <div class="description">
2145 <p>Fetch the list of associated peers.</p>
2146 </div>
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156 <dl class="details">
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178 </dl>
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190 <h5>Returns:</h5>
2191
2192
2193
2194 <table class="params">
2195 <thead>
2196 <tr>
2197
2198 <th>Type</th>
2199 <th class="last">Description</th>
2200 </tr>
2201 </thead>
2202 <tbody>
2203
2204 <tr>
2205
2206 <td class="type">
2207
2208 Promise.&lt;Array.&lt;<a href="LuCI.Network.html#.WifiPeerEntry">LuCI.Network.WifiPeerEntry</a>>>
2209
2210
2211 </td>
2212 <td class="description last">Returns a promise resolving to an array of wireless peers associated
2213 with this network.</td>
2214 </tr>
2215
2216 </tbody>
2217 </table>
2218
2219
2220
2221
2222 </dd>
2223
2224
2225
2226 <dt>
2227 <div class="nameContainer">
2228 <h4 class="name" id="getBitRate">
2229
2230 getBitRate<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
2231 </h4>
2232
2233
2234 <div class="tag-source">
2235 network.js, line 3845
2236 </div>
2237
2238 </div>
2239
2240
2241 </dt>
2242 <dd>
2243
2244
2245 <div class="description">
2246 <p>Query the current average bitrate of all peers associated to this
2247 wireless network.</p>
2248 </div>
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258 <dl class="details">
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280 </dl>
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292 <h5>Returns:</h5>
2293
2294
2295
2296 <table class="params">
2297 <thead>
2298 <tr>
2299
2300 <th>Type</th>
2301 <th class="last">Description</th>
2302 </tr>
2303 </thead>
2304 <tbody>
2305
2306 <tr>
2307
2308 <td class="type">
2309
2310 null
2311 |
2312
2313 number
2314
2315
2316 </td>
2317 <td class="description last">Returns the average bit rate among all peers associated to the network
2318 as reported by <code>ubus</code> runtime information or <code>null</code> if the information
2319 is not available.</td>
2320 </tr>
2321
2322 </tbody>
2323 </table>
2324
2325
2326
2327
2328 </dd>
2329
2330
2331
2332 <dt>
2333 <div class="nameContainer">
2334 <h4 class="name" id="getBSSID">
2335
2336 getBSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2337 </h4>
2338
2339
2340 <div class="tag-source">
2341 network.js, line 3450
2342 </div>
2343
2344 </div>
2345
2346
2347 </dt>
2348 <dd>
2349
2350
2351 <div class="description">
2352 <p>Get the configured BSSID of the wireless network.</p>
2353 </div>
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363 <dl class="details">
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385 </dl>
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397 <h5>Returns:</h5>
2398
2399
2400
2401 <table class="params">
2402 <thead>
2403 <tr>
2404
2405 <th>Type</th>
2406 <th class="last">Description</th>
2407 </tr>
2408 </thead>
2409 <tbody>
2410
2411 <tr>
2412
2413 <td class="type">
2414
2415 null
2416 |
2417
2418 string
2419
2420
2421 </td>
2422 <td class="description last">Returns the BSSID value or <code>null</code> if none has been specified.</td>
2423 </tr>
2424
2425 </tbody>
2426 </table>
2427
2428
2429
2430
2431 </dd>
2432
2433
2434
2435 <dt>
2436 <div class="nameContainer">
2437 <h4 class="name" id="getChannel">
2438
2439 getChannel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
2440 </h4>
2441
2442
2443 <div class="tag-source">
2444 network.js, line 3861
2445 </div>
2446
2447 </div>
2448
2449
2450 </dt>
2451 <dd>
2452
2453
2454 <div class="description">
2455 <p>Query the current wireless channel.</p>
2456 </div>
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466 <dl class="details">
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488 </dl>
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500 <h5>Returns:</h5>
2501
2502
2503
2504 <table class="params">
2505 <thead>
2506 <tr>
2507
2508 <th>Type</th>
2509 <th class="last">Description</th>
2510 </tr>
2511 </thead>
2512 <tbody>
2513
2514 <tr>
2515
2516 <td class="type">
2517
2518 null
2519 |
2520
2521 number
2522
2523
2524 </td>
2525 <td class="description last">Returns the wireless channel as reported by <code>ubus</code> runtime information
2526 or <code>null</code> if it cannot be determined.</td>
2527 </tr>
2528
2529 </tbody>
2530 </table>
2531
2532
2533
2534
2535 </dd>
2536
2537
2538
2539 <dt>
2540 <div class="nameContainer">
2541 <h4 class="name" id="getCountryCode">
2542
2543 getCountryCode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2544 </h4>
2545
2546
2547 <div class="tag-source">
2548 network.js, line 3894
2549 </div>
2550
2551 </div>
2552
2553
2554 </dt>
2555 <dd>
2556
2557
2558 <div class="description">
2559 <p>Query the current country code.</p>
2560 </div>
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570 <dl class="details">
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592 </dl>
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604 <h5>Returns:</h5>
2605
2606
2607
2608 <table class="params">
2609 <thead>
2610 <tr>
2611
2612 <th>Type</th>
2613 <th class="last">Description</th>
2614 </tr>
2615 </thead>
2616 <tbody>
2617
2618 <tr>
2619
2620 <td class="type">
2621
2622 string
2623
2624
2625 </td>
2626 <td class="description last">Returns the wireless country code as reported by <code>ubus</code> runtime
2627 information or <code>00</code> if it cannot be determined.</td>
2628 </tr>
2629
2630 </tbody>
2631 </table>
2632
2633
2634
2635
2636 </dd>
2637
2638
2639
2640 <dt>
2641 <div class="nameContainer">
2642 <h4 class="name" id="getDevice">
2643
2644 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>
2645 </h4>
2646
2647
2648 <div class="tag-source">
2649 network.js, line 4040
2650 </div>
2651
2652 </div>
2653
2654
2655 </dt>
2656 <dd>
2657
2658
2659 <div class="description">
2660 <p>Get the associated Linux network device.</p>
2661 </div>
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671 <dl class="details">
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693 </dl>
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705 <h5>Returns:</h5>
2706
2707
2708
2709 <table class="params">
2710 <thead>
2711 <tr>
2712
2713 <th>Type</th>
2714 <th class="last">Description</th>
2715 </tr>
2716 </thead>
2717 <tbody>
2718
2719 <tr>
2720
2721 <td class="type">
2722
2723 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
2724
2725
2726 </td>
2727 <td class="description last">Returns a <code>Network.Device</code> instance representing the Linux network
2728 device associted with this wireless network.</td>
2729 </tr>
2730
2731 </tbody>
2732 </table>
2733
2734
2735
2736
2737 </dd>
2738
2739
2740
2741 <dt>
2742 <div class="nameContainer">
2743 <h4 class="name" id="getFrequency">
2744
2745 getFrequency<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2746 </h4>
2747
2748
2749 <div class="tag-source">
2750 network.js, line 3827
2751 </div>
2752
2753 </div>
2754
2755
2756 </dt>
2757 <dd>
2758
2759
2760 <div class="description">
2761 <p>Query the current operating frequency of the wireless network.</p>
2762 </div>
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772 <dl class="details">
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794 </dl>
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806 <h5>Returns:</h5>
2807
2808
2809
2810 <table class="params">
2811 <thead>
2812 <tr>
2813
2814 <th>Type</th>
2815 <th class="last">Description</th>
2816 </tr>
2817 </thead>
2818 <tbody>
2819
2820 <tr>
2821
2822 <td class="type">
2823
2824 null
2825 |
2826
2827 string
2828
2829
2830 </td>
2831 <td class="description last">Returns the current operating frequency of the network from <code>ubus</code>
2832 runtime information in GHz or <code>null</code> if the information is not
2833 available.</td>
2834 </tr>
2835
2836 </tbody>
2837 </table>
2838
2839
2840
2841
2842 </dd>
2843
2844
2845
2846 <dt>
2847 <div class="nameContainer">
2848 <h4 class="name" id="getI18n">
2849
2850 getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2851 </h4>
2852
2853
2854 <div class="tag-source">
2855 network.js, line 3988
2856 </div>
2857
2858 </div>
2859
2860
2861 </dt>
2862 <dd>
2863
2864
2865 <div class="description">
2866 <p>Get a description string for this wireless network.</p>
2867 </div>
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877 <dl class="details">
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899 </dl>
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911 <h5>Returns:</h5>
2912
2913
2914
2915 <table class="params">
2916 <thead>
2917 <tr>
2918
2919 <th>Type</th>
2920 <th class="last">Description</th>
2921 </tr>
2922 </thead>
2923 <tbody>
2924
2925 <tr>
2926
2927 <td class="type">
2928
2929 string
2930
2931
2932 </td>
2933 <td class="description last">Returns a string describing this network, consisting of the
2934 term <code>Wireless Network</code>, followed by the active operation mode,
2935 the SSID, BSSID or internal network ID and the Linux network device
2936 name, depending on which information is available.</td>
2937 </tr>
2938
2939 </tbody>
2940 </table>
2941
2942
2943
2944
2945 </dd>
2946
2947
2948
2949 <dt>
2950 <div class="nameContainer">
2951 <h4 class="name" id="getID">
2952
2953 getID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2954 </h4>
2955
2956
2957 <div class="tag-source">
2958 network.js, line 3475
2959 </div>
2960
2961 </div>
2962
2963
2964 </dt>
2965 <dd>
2966
2967
2968 <div class="description">
2969 <p>Get the internal network ID of this wireless network.</p>
2970 <p>The network ID is a LuCI specific identifer in the form
2971 <code>radio#.network#</code> to identify wireless networks by their corresponding
2972 radio and network index numbers.</p>
2973 </div>
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983 <dl class="details">
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005 </dl>
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017 <h5>Returns:</h5>
3018
3019
3020
3021 <table class="params">
3022 <thead>
3023 <tr>
3024
3025 <th>Type</th>
3026 <th class="last">Description</th>
3027 </tr>
3028 </thead>
3029 <tbody>
3030
3031 <tr>
3032
3033 <td class="type">
3034
3035 string
3036
3037
3038 </td>
3039 <td class="description last">Returns the LuCI specific network ID.</td>
3040 </tr>
3041
3042 </tbody>
3043 </table>
3044
3045
3046
3047
3048 </dd>
3049
3050
3051
3052 <dt>
3053 <div class="nameContainer">
3054 <h4 class="name" id="getIfname">
3055
3056 getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3057 </h4>
3058
3059
3060 <div class="tag-source">
3061 network.js, line 3497
3062 </div>
3063
3064 </div>
3065
3066
3067 </dt>
3068 <dd>
3069
3070
3071 <div class="description">
3072 <p>Get the Linux network device name.</p>
3073 </div>
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083 <dl class="details">
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105 </dl>
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117 <h5>Returns:</h5>
3118
3119
3120
3121 <table class="params">
3122 <thead>
3123 <tr>
3124
3125 <th>Type</th>
3126 <th class="last">Description</th>
3127 </tr>
3128 </thead>
3129 <tbody>
3130
3131 <tr>
3132
3133 <td class="type">
3134
3135 null
3136 |
3137
3138 string
3139
3140
3141 </td>
3142 <td class="description last">Returns the current Linux network device name as resolved from
3143 <code>ubus</code> runtime information or <code>null</code> if this network has no
3144 associated network device, e.g. when not configured or up.</td>
3145 </tr>
3146
3147 </tbody>
3148 </table>
3149
3150
3151
3152
3153 </dd>
3154
3155
3156
3157 <dt>
3158 <div class="nameContainer">
3159 <h4 class="name" id="getMeshID">
3160
3161 getMeshID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3162 </h4>
3163
3164
3165 <div class="tag-source">
3166 network.js, line 3437
3167 </div>
3168
3169 </div>
3170
3171
3172 </dt>
3173 <dd>
3174
3175
3176 <div class="description">
3177 <p>Get the configured Mesh ID of the wireless network.</p>
3178 </div>
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188 <dl class="details">
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210 </dl>
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222 <h5>Returns:</h5>
3223
3224
3225
3226 <table class="params">
3227 <thead>
3228 <tr>
3229
3230 <th>Type</th>
3231 <th class="last">Description</th>
3232 </tr>
3233 </thead>
3234 <tbody>
3235
3236 <tr>
3237
3238 <td class="type">
3239
3240 null
3241 |
3242
3243 string
3244
3245
3246 </td>
3247 <td class="description last">Returns the configured mesh ID value or <code>null</code> when this network
3248 is not in mesh mode.</td>
3249 </tr>
3250
3251 </tbody>
3252 </table>
3253
3254
3255
3256
3257 </dd>
3258
3259
3260
3261 <dt>
3262 <div class="nameContainer">
3263 <h4 class="name" id="getMode">
3264
3265 getMode<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3266 </h4>
3267
3268
3269 <div class="tag-source">
3270 network.js, line 3412
3271 </div>
3272
3273 </div>
3274
3275
3276 </dt>
3277 <dd>
3278
3279
3280 <div class="description">
3281 <p>Get the configured operation mode of the wireless network.</p>
3282 </div>
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292 <dl class="details">
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314 </dl>
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326 <h5>Returns:</h5>
3327
3328
3329
3330 <table class="params">
3331 <thead>
3332 <tr>
3333
3334 <th>Type</th>
3335 <th class="last">Description</th>
3336 </tr>
3337 </thead>
3338 <tbody>
3339
3340 <tr>
3341
3342 <td class="type">
3343
3344 string
3345
3346
3347 </td>
3348 <td class="description last">Returns the configured operation mode. Possible values are:
3349 <ul>
3350 <li><code>ap</code> - Master (Access Point) mode</li>
3351 <li><code>sta</code> - Station (client) mode</li>
3352 <li><code>adhoc</code> - Ad-Hoc (IBSS) mode</li>
3353 <li><code>mesh</code> - Mesh (IEEE 802.11s) mode</li>
3354 <li><code>monitor</code> - Monitor mode</li>
3355 </ul></td>
3356 </tr>
3357
3358 </tbody>
3359 </table>
3360
3361
3362
3363
3364 </dd>
3365
3366
3367
3368 <dt>
3369 <div class="nameContainer">
3370 <h4 class="name" id="getName">
3371
3372 getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3373 </h4>
3374
3375
3376 <div class="tag-source">
3377 network.js, line 3485
3378 </div>
3379
3380 </div>
3381
3382
3383 </dt>
3384 <dd>
3385
3386
3387 <div class="description">
3388 <p>Get the configuration ID of this wireless network.</p>
3389 </div>
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399 <dl class="details">
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421 </dl>
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433 <h5>Returns:</h5>
3434
3435
3436
3437 <table class="params">
3438 <thead>
3439 <tr>
3440
3441 <th>Type</th>
3442 <th class="last">Description</th>
3443 </tr>
3444 </thead>
3445 <tbody>
3446
3447 <tr>
3448
3449 <td class="type">
3450
3451 string
3452
3453
3454 </td>
3455 <td class="description last">Returns the corresponding UCI section ID of the network.</td>
3456 </tr>
3457
3458 </tbody>
3459 </table>
3460
3461
3462
3463
3464 </dd>
3465
3466
3467
3468 <dt>
3469 <div class="nameContainer">
3470 <h4 class="name" id="getNetwork">
3471
3472 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>
3473 </h4>
3474
3475
3476 <div class="tag-source">
3477 network.js, line 4004
3478 </div>
3479
3480 </div>
3481
3482
3483 </dt>
3484 <dd>
3485
3486
3487 <div class="description">
3488 <p>Get the primary logical interface this wireless network is attached to.</p>
3489 </div>
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499 <dl class="details">
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521 </dl>
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533 <h5>Returns:</h5>
3534
3535
3536
3537 <table class="params">
3538 <thead>
3539 <tr>
3540
3541 <th>Type</th>
3542 <th class="last">Description</th>
3543 </tr>
3544 </thead>
3545 <tbody>
3546
3547 <tr>
3548
3549 <td class="type">
3550
3551 null
3552 |
3553
3554 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
3555
3556
3557 </td>
3558 <td class="description last">Returns a <code>Network.Protocol</code> instance representing the logical
3559 interface or <code>null</code> if this network is not attached to any logical
3560 interface.</td>
3561 </tr>
3562
3563 </tbody>
3564 </table>
3565
3566
3567
3568
3569 </dd>
3570
3571
3572
3573 <dt>
3574 <div class="nameContainer">
3575 <h4 class="name" id="getNetworkNames">
3576
3577 getNetworkNames<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
3578 </h4>
3579
3580
3581 <div class="tag-source">
3582 network.js, line 3461
3583 </div>
3584
3585 </div>
3586
3587
3588 </dt>
3589 <dd>
3590
3591
3592 <div class="description">
3593 <p>Get the names of the logical interfaces this wireless network is
3594 attached to.</p>
3595 </div>
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605 <dl class="details">
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627 </dl>
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639 <h5>Returns:</h5>
3640
3641
3642
3643 <table class="params">
3644 <thead>
3645 <tr>
3646
3647 <th>Type</th>
3648 <th class="last">Description</th>
3649 </tr>
3650 </thead>
3651 <tbody>
3652
3653 <tr>
3654
3655 <td class="type">
3656
3657 Array.&lt;string>
3658
3659
3660 </td>
3661 <td class="description last">Returns an array of logical interface names.</td>
3662 </tr>
3663
3664 </tbody>
3665 </table>
3666
3667
3668
3669
3670 </dd>
3671
3672
3673
3674 <dt>
3675 <div class="nameContainer">
3676 <h4 class="name" id="getNetworks">
3677
3678 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>
3679 </h4>
3680
3681
3682 <div class="tag-source">
3683 network.js, line 4015
3684 </div>
3685
3686 </div>
3687
3688
3689 </dt>
3690 <dd>
3691
3692
3693 <div class="description">
3694 <p>Get the logical interfaces this wireless network is attached to.</p>
3695 </div>
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705 <dl class="details">
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727 </dl>
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739 <h5>Returns:</h5>
3740
3741
3742
3743 <table class="params">
3744 <thead>
3745 <tr>
3746
3747 <th>Type</th>
3748 <th class="last">Description</th>
3749 </tr>
3750 </thead>
3751 <tbody>
3752
3753 <tr>
3754
3755 <td class="type">
3756
3757 Array.&lt;<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>
3758
3759
3760 </td>
3761 <td class="description last">Returns an array of <code>Network.Protocol</code> instances representing the
3762 logical interfaces this wireless network is attached to.</td>
3763 </tr>
3764
3765 </tbody>
3766 </table>
3767
3768
3769
3770
3771 </dd>
3772
3773
3774
3775 <dt>
3776 <div class="nameContainer">
3777 <h4 class="name" id="getNoise">
3778
3779 getNoise<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
3780 </h4>
3781
3782
3783 <div class="tag-source">
3784 network.js, line 3883
3785 </div>
3786
3787 </div>
3788
3789
3790 </dt>
3791 <dd>
3792
3793
3794 <div class="description">
3795 <p>Query the current radio noise floor.</p>
3796 </div>
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806 <dl class="details">
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828 </dl>
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840 <h5>Returns:</h5>
3841
3842
3843
3844 <table class="params">
3845 <thead>
3846 <tr>
3847
3848 <th>Type</th>
3849 <th class="last">Description</th>
3850 </tr>
3851 </thead>
3852 <tbody>
3853
3854 <tr>
3855
3856 <td class="type">
3857
3858 number
3859
3860
3861 </td>
3862 <td class="description last">Returns the radio noise floor in dBm as reported by <code>ubus</code> runtime
3863 information or <code>0</code> if it cannot be determined.</td>
3864 </tr>
3865
3866 </tbody>
3867 </table>
3868
3869
3870
3871
3872 </dd>
3873
3874
3875
3876 <dt>
3877 <div class="nameContainer">
3878 <h4 class="name" id="getShortName">
3879
3880 getShortName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3881 </h4>
3882
3883
3884 <div class="tag-source">
3885 network.js, line 3973
3886 </div>
3887
3888 </div>
3889
3890
3891 </dt>
3892 <dd>
3893
3894
3895 <div class="description">
3896 <p>Get a short description string for this wireless network.</p>
3897 </div>
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907 <dl class="details">
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929 </dl>
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941 <h5>Returns:</h5>
3942
3943
3944
3945 <table class="params">
3946 <thead>
3947 <tr>
3948
3949 <th>Type</th>
3950 <th class="last">Description</th>
3951 </tr>
3952 </thead>
3953 <tbody>
3954
3955 <tr>
3956
3957 <td class="type">
3958
3959 string
3960
3961
3962 </td>
3963 <td class="description last">Returns a string describing this network, consisting of the
3964 active operation mode, followed by either the SSID, BSSID or
3965 internal network ID, depending on which information is available.</td>
3966 </tr>
3967
3968 </tbody>
3969 </table>
3970
3971
3972
3973
3974 </dd>
3975
3976
3977
3978 <dt>
3979 <div class="nameContainer">
3980 <h4 class="name" id="getSignal">
3981
3982 getSignal<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
3983 </h4>
3984
3985
3986 <div class="tag-source">
3987 network.js, line 3872
3988 </div>
3989
3990 </div>
3991
3992
3993 </dt>
3994 <dd>
3995
3996
3997 <div class="description">
3998 <p>Query the current wireless signal.</p>
3999 </div>
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009 <dl class="details">
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031 </dl>
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043 <h5>Returns:</h5>
4044
4045
4046
4047 <table class="params">
4048 <thead>
4049 <tr>
4050
4051 <th>Type</th>
4052 <th class="last">Description</th>
4053 </tr>
4054 </thead>
4055 <tbody>
4056
4057 <tr>
4058
4059 <td class="type">
4060
4061 null
4062 |
4063
4064 number
4065
4066
4067 </td>
4068 <td class="description last">Returns the wireless signal in dBm as reported by <code>ubus</code> runtime
4069 information or <code>null</code> if it cannot be determined.</td>
4070 </tr>
4071
4072 </tbody>
4073 </table>
4074
4075
4076
4077
4078 </dd>
4079
4080
4081
4082 <dt>
4083 <div class="nameContainer">
4084 <h4 class="name" id="getSignalLevel">
4085
4086 getSignalLevel<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4087 </h4>
4088
4089
4090 <div class="tag-source">
4091 network.js, line 3932
4092 </div>
4093
4094 </div>
4095
4096
4097 </dt>
4098 <dd>
4099
4100
4101 <div class="description">
4102 <p>Calculate the current signal.</p>
4103 </div>
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113 <dl class="details">
4114
4115
4116
4117
4118
4119
4120
4121 <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137 </dl>
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149 <h5>Returns:</h5>
4150
4151
4152
4153 <table class="params">
4154 <thead>
4155 <tr>
4156
4157 <th>Type</th>
4158 <th class="last">Description</th>
4159 </tr>
4160 </thead>
4161 <tbody>
4162
4163 <tr>
4164
4165 <td class="type">
4166
4167 number
4168
4169
4170 </td>
4171 <td class="description last">Returns the calculated signal level, which is the difference between
4172 noise and signal (SNR), divided by 5.</td>
4173 </tr>
4174
4175 </tbody>
4176 </table>
4177
4178
4179
4180
4181 </dd>
4182
4183
4184
4185 <dt>
4186 <div class="nameContainer">
4187 <h4 class="name" id="getSignalPercent">
4188
4189 getSignalPercent<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4190 </h4>
4191
4192
4193 <div class="tag-source">
4194 network.js, line 3955
4195 </div>
4196
4197 </div>
4198
4199
4200 </dt>
4201 <dd>
4202
4203
4204 <div class="description">
4205 <p>Calculate the current signal quality percentage.</p>
4206 </div>
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216 <dl class="details">
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238 </dl>
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250 <h5>Returns:</h5>
4251
4252
4253
4254 <table class="params">
4255 <thead>
4256 <tr>
4257
4258 <th>Type</th>
4259 <th class="last">Description</th>
4260 </tr>
4261 </thead>
4262 <tbody>
4263
4264 <tr>
4265
4266 <td class="type">
4267
4268 number
4269
4270
4271 </td>
4272 <td class="description last">Returns the calculated signal quality in percent. The value is
4273 calculated from the <code>quality</code> and <code>quality_max</code> indicators reported
4274 by <code>ubus</code> runtime state.</td>
4275 </tr>
4276
4277 </tbody>
4278 </table>
4279
4280
4281
4282
4283 </dd>
4284
4285
4286
4287 <dt>
4288 <div class="nameContainer">
4289 <h4 class="name" id="getSSID">
4290
4291 getSSID<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4292 </h4>
4293
4294
4295 <div class="tag-source">
4296 network.js, line 3423
4297 </div>
4298
4299 </div>
4300
4301
4302 </dt>
4303 <dd>
4304
4305
4306 <div class="description">
4307 <p>Get the configured SSID of the wireless network.</p>
4308 </div>
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318 <dl class="details">
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340 </dl>
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352 <h5>Returns:</h5>
4353
4354
4355
4356 <table class="params">
4357 <thead>
4358 <tr>
4359
4360 <th>Type</th>
4361 <th class="last">Description</th>
4362 </tr>
4363 </thead>
4364 <tbody>
4365
4366 <tr>
4367
4368 <td class="type">
4369
4370 null
4371 |
4372
4373 string
4374
4375
4376 </td>
4377 <td class="description last">Returns the configured SSID value or <code>null</code> when this network is
4378 in mesh mode.</td>
4379 </tr>
4380
4381 </tbody>
4382 </table>
4383
4384
4385
4386
4387 </dd>
4388
4389
4390
4391 <dt>
4392 <div class="nameContainer">
4393 <h4 class="name" id="getTXPower">
4394
4395 getTXPower<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span>
4396 </h4>
4397
4398
4399 <div class="tag-source">
4400 network.js, line 3905
4401 </div>
4402
4403 </div>
4404
4405
4406 </dt>
4407 <dd>
4408
4409
4410 <div class="description">
4411 <p>Query the current radio TX power.</p>
4412 </div>
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422 <dl class="details">
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444 </dl>
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456 <h5>Returns:</h5>
4457
4458
4459
4460 <table class="params">
4461 <thead>
4462 <tr>
4463
4464 <th>Type</th>
4465 <th class="last">Description</th>
4466 </tr>
4467 </thead>
4468 <tbody>
4469
4470 <tr>
4471
4472 <td class="type">
4473
4474 null
4475 |
4476
4477 number
4478
4479
4480 </td>
4481 <td class="description last">Returns the wireless network transmit power in dBm as reported by
4482 <code>ubus</code> runtime information or <code>null</code> if it cannot be determined.</td>
4483 </tr>
4484
4485 </tbody>
4486 </table>
4487
4488
4489
4490
4491 </dd>
4492
4493
4494
4495 <dt>
4496 <div class="nameContainer">
4497 <h4 class="name" id="getTXPowerOffset">
4498
4499 getTXPowerOffset<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4500 </h4>
4501
4502
4503 <div class="tag-source">
4504 network.js, line 3920
4505 </div>
4506
4507 </div>
4508
4509
4510 </dt>
4511 <dd>
4512
4513
4514 <div class="description">
4515 <p>Query the radio TX power offset.</p>
4516 <p>Some wireless radios have a fixed power offset, e.g. due to the
4517 use of external amplifiers.</p>
4518 </div>
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528 <dl class="details">
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550 </dl>
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562 <h5>Returns:</h5>
4563
4564
4565
4566 <table class="params">
4567 <thead>
4568 <tr>
4569
4570 <th>Type</th>
4571 <th class="last">Description</th>
4572 </tr>
4573 </thead>
4574 <tbody>
4575
4576 <tr>
4577
4578 <td class="type">
4579
4580 number
4581
4582
4583 </td>
4584 <td class="description last">Returns the wireless network transmit power offset in dBm as reported
4585 by <code>ubus</code> runtime information or <code>0</code> if there is no offset, or if it
4586 cannot be determined.</td>
4587 </tr>
4588
4589 </tbody>
4590 </table>
4591
4592
4593
4594
4595 </dd>
4596
4597
4598
4599 <dt>
4600 <div class="nameContainer">
4601 <h4 class="name" id="getWifiDevice">
4602
4603 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>
4604 </h4>
4605
4606
4607 <div class="tag-source">
4608 network.js, line 3525
4609 </div>
4610
4611 </div>
4612
4613
4614 </dt>
4615 <dd>
4616
4617
4618 <div class="description">
4619 <p>Get the corresponding wifi radio device.</p>
4620 </div>
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630 <dl class="details">
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652 </dl>
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664 <h5>Returns:</h5>
4665
4666
4667
4668 <table class="params">
4669 <thead>
4670 <tr>
4671
4672 <th>Type</th>
4673 <th class="last">Description</th>
4674 </tr>
4675 </thead>
4676 <tbody>
4677
4678 <tr>
4679
4680 <td class="type">
4681
4682 null
4683 |
4684
4685 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
4686
4687
4688 </td>
4689 <td class="description last">Returns a <code>Network.WifiDevice</code> instance representing the corresponding
4690 wifi radio device or <code>null</code> if the related radio device could not be
4691 found.</td>
4692 </tr>
4693
4694 </tbody>
4695 </table>
4696
4697
4698
4699
4700 </dd>
4701
4702
4703
4704 <dt>
4705 <div class="nameContainer">
4706 <h4 class="name" id="getWifiDeviceName">
4707
4708 getWifiDeviceName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4709 </h4>
4710
4711
4712 <div class="tag-source">
4713 network.js, line 3513
4714 </div>
4715
4716 </div>
4717
4718
4719 </dt>
4720 <dd>
4721
4722
4723 <div class="description">
4724 <p>Get the name of the corresponding wifi radio device.</p>
4725 </div>
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735 <dl class="details">
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757 </dl>
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769 <h5>Returns:</h5>
4770
4771
4772
4773 <table class="params">
4774 <thead>
4775 <tr>
4776
4777 <th>Type</th>
4778 <th class="last">Description</th>
4779 </tr>
4780 </thead>
4781 <tbody>
4782
4783 <tr>
4784
4785 <td class="type">
4786
4787 null
4788 |
4789
4790 string
4791
4792
4793 </td>
4794 <td class="description last">Returns the name of the radio device this network is configured on
4795 or <code>null</code> if it cannot be determined.</td>
4796 </tr>
4797
4798 </tbody>
4799 </table>
4800
4801
4802
4803
4804 </dd>
4805
4806
4807
4808 <dt>
4809 <div class="nameContainer">
4810 <h4 class="name" id="isClientDisconnectSupported">
4811
4812 isClientDisconnectSupported<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4813 </h4>
4814
4815
4816 <div class="tag-source">
4817 network.js, line 4051
4818 </div>
4819
4820 </div>
4821
4822
4823 </dt>
4824 <dd>
4825
4826
4827 <div class="description">
4828 <p>Check whether this wifi network supports deauthenticating clients.</p>
4829 </div>
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839 <dl class="details">
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861 </dl>
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873 <h5>Returns:</h5>
4874
4875
4876
4877 <table class="params">
4878 <thead>
4879 <tr>
4880
4881 <th>Type</th>
4882 <th class="last">Description</th>
4883 </tr>
4884 </thead>
4885 <tbody>
4886
4887 <tr>
4888
4889 <td class="type">
4890
4891 boolean
4892
4893
4894 </td>
4895 <td class="description last">Returns <code>true</code> when this wifi network instance supports forcibly
4896 deauthenticating clients, otherwise <code>false</code>.</td>
4897 </tr>
4898
4899 </tbody>
4900 </table>
4901
4902
4903
4904
4905 </dd>
4906
4907
4908
4909 <dt>
4910 <div class="nameContainer">
4911 <h4 class="name" id="isDisabled">
4912
4913 isDisabled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4914 </h4>
4915
4916
4917 <div class="tag-source">
4918 network.js, line 3397
4919 </div>
4920
4921 </div>
4922
4923
4924 </dt>
4925 <dd>
4926
4927
4928 <div class="description">
4929 <p>Checks whether this wireless network is disabled.</p>
4930 </div>
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940 <dl class="details">
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962 </dl>
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974 <h5>Returns:</h5>
4975
4976
4977
4978 <table class="params">
4979 <thead>
4980 <tr>
4981
4982 <th>Type</th>
4983 <th class="last">Description</th>
4984 </tr>
4985 </thead>
4986 <tbody>
4987
4988 <tr>
4989
4990 <td class="type">
4991
4992 boolean
4993
4994
4995 </td>
4996 <td class="description last">Returns <code>true</code> when the wireless radio is marked as disabled in <code>ubus</code>
4997 runtime state or when the <code>disabled</code> option is set in the corresponding
4998 UCI configuration.</td>
4999 </tr>
5000
5001 </tbody>
5002 </table>
5003
5004
5005
5006
5007 </dd>
5008
5009
5010
5011 <dt>
5012 <div class="nameContainer">
5013 <h4 class="name" id="isUp">
5014
5015 isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
5016 </h4>
5017
5018
5019 <div class="tag-source">
5020 network.js, line 3546
5021 </div>
5022
5023 </div>
5024
5025
5026 </dt>
5027 <dd>
5028
5029
5030 <div class="description">
5031 <p>Check whether the radio network is up.</p>
5032 <p>This function actually queries the up state of the related radio
5033 device and assumes this network to be up as well when the parent
5034 radio is up. This is due to the fact that OpenWrt does not control
5035 virtual interfaces individually but within one common hostapd
5036 instance.</p>
5037 </div>
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047 <dl class="details">
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069 </dl>
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081 <h5>Returns:</h5>
5082
5083
5084
5085 <table class="params">
5086 <thead>
5087 <tr>
5088
5089 <th>Type</th>
5090 <th class="last">Description</th>
5091 </tr>
5092 </thead>
5093 <tbody>
5094
5095 <tr>
5096
5097 <td class="type">
5098
5099 boolean
5100
5101
5102 </td>
5103 <td class="description last">Returns <code>true</code> when the network is up, else <code>false</code>.</td>
5104 </tr>
5105
5106 </tbody>
5107 </table>
5108
5109
5110
5111
5112 </dd>
5113
5114
5115
5116 <dt>
5117 <div class="nameContainer">
5118 <h4 class="name" id="set">
5119
5120 set<span class="signature">(opt, val)</span>
5121 </h4>
5122
5123
5124 <div class="tag-source">
5125 network.js, line 3385
5126 </div>
5127
5128 </div>
5129
5130
5131 </dt>
5132 <dd>
5133
5134
5135 <div class="description">
5136 <p>Set the given UCI option of this network to the given value.</p>
5137 </div>
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147 <table class="params">
5148 <thead>
5149 <tr>
5150
5151 <th>Name</th>
5152
5153
5154 <th>Type</th>
5155
5156
5157
5158 <th class="last">Description</th>
5159 </tr>
5160 </thead>
5161
5162 <tbody>
5163
5164
5165 <tr>
5166
5167 <td class="name"><code>opt</code></td>
5168
5169
5170 <td class="type">
5171
5172
5173 <span class="param-type">string</span>
5174
5175
5176
5177 </td>
5178
5179
5180
5181 <td class="description last">
5182
5183 <p>The name of the UCI option to set.</p></td>
5184 </tr>
5185
5186
5187
5188 <tr>
5189
5190 <td class="name"><code>val</code></td>
5191
5192
5193 <td class="type">
5194
5195
5196 <span class="param-type">null</span>
5197 |
5198
5199 <span class="param-type">string</span>
5200 |
5201
5202 <span class="param-type">Array.&lt;string></span>
5203
5204
5205
5206 </td>
5207
5208
5209
5210 <td class="description last">
5211
5212 <p>The value to set or <code>null</code> to remove the given option from the
5213 configuration.</p></td>
5214 </tr>
5215
5216
5217 </tbody>
5218 </table>
5219
5220
5221
5222 <dl class="details">
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244 </dl>
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258 </dd>
5259
5260 </dl>
5261
5262
5263
5264
5265
5266
5267
5268 </article>
5269
5270 </section>
5271
5272
5273
5274
5275
5276
5277
5278 <footer>
5279 Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:20:51 GMT+0100 (Central European Standard Time)
5280 </footer>
5281 </div>
5282 </div>
5283 <script>prettyPrint();</script>
5284 <script src="scripts/jaguar.js"></script>
5285 </body>
5286 </html>