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