docs/developer/wifi-radar.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2           "http://www.w3.org/TR/html40/loose.dtd">
   3
   4 <html>
   5
   6   <head>
   7     <title>HappyDoc Generated Documentation</title>
   8   </head>
   9
  10   <body bgcolor="#ffffff">
  11
  12
  13         <table border="0" cellpadding="5" cellspacing="0" width="100%">
  14         <tr>
  15             <th rowspan="2"
  16                 valign="top"
  17                 align="left"
  18                 width="10%"
  19                 bgcolor="#88bbee"><font color="#000000">HappyDoc Generated Documentation</font>
  20             </th>
  21             <th bgcolor="#88bbee"
  22                 width="90%"
  23                 align="right"><font color="#000000">wifi-radar.py</font>
  24             </th>
  25         </tr>
  26         <tr>
  27         <td>
  28         <table border="0" cellpadding="5" cellspacing="0" width="100%">
  29
  30         <tr>
  31             <th bgcolor="#99ccff"
  32                 rowspan="2"
  33                 valign="top"
  34                 align="left"
  35                 width="20%"
  36                 >
  37                 <font color="#000000">
  38                   <a name="">Functions</a>&nbsp;
  39                 </font>
  40             </th>
  41             <th bgcolor="#99ccff"
  42                 valign="top"
  43                 align="left"
  44                 width="80%"
  45                 >
  46                 <font color="#000000">&nbsp;</font>
  47             </th>
  48         </tr>
  49         <tr>
  50         <td>
  51         <table border="0" cellpadding="5" cellspacing="0" width="100%">
  52
  53         <tr>
  54             <th bgcolor="#99ccff"
  55                 rowspan="2"
  56                 valign="top"
  57                 align="left"
  58                 width="20%"
  59                 >
  60                 <font color="#000000">
  61                   <a name="scanning_thread"></a>&nbsp;
  62                 </font>
  63             </th>
  64             <th bgcolor="#99ccff"
  65                 valign="top"
  66                 align="left"
  67                 width="80%"
  68                 >
  69                 <font color="#000000">scanning_thread&nbsp;</font>
  70             </th>
  71         </tr>
  72         <tr>
  73         <td>
  74         <pre>
  75 scanning_thread (
  76         confFile,
  77         apQueue,
  78         commandQueue,
  79         logger,
  80         exit_event,
  81         )
  82 </pre>
  83
  84 <p>Scan for a limited time and return AP names and bssid found.
  85  Access points we find will be put on the outgoing Queue, apQueue.</p>
  86 <h4>Parameters:</h4>
  87 <dl>
  88 <dt>        <code>confFile</code></dt>
  89 <dd>ConfigFile - Config file object</dd>
  90 <dt>        <code>apQueue</code></dt>
  91 <dd>Queue - Queue on which to put AP profiles</dd>
  92 <dt>        <code>commandQueue</code></dt>
  93 <dd>Queue - Queue from which to read commands</dd>
  94 <dt>        <code>logger</code></dt>
  95 <dd>Logger - Python's logging facility</dd>
  96 </dl>
  97 <h4>Returns:</h4>
  98 <p>        nothing</p>
  99 </td></tr>
 100 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 101
 102         <tr>
 103             <th bgcolor="#99ccff"
 104                 rowspan="2"
 105                 valign="top"
 106                 align="left"
 107                 width="20%"
 108                 >
 109                 <font color="#000000">
 110                   <a name="split_section_name"></a>&nbsp;
 111                 </font>
 112             </th>
 113             <th bgcolor="#99ccff"
 114                 valign="top"
 115                 align="left"
 116                 width="80%"
 117                 >
 118                 <font color="#000000">split_section_name&nbsp;</font>
 119             </th>
 120         </tr>
 121         <tr>
 122         <td>
 123         <pre>
 124 split_section_name ( section )
 125 </pre>
 126
 127 <p>Split a config file section name into an essid and a bssid</p>
 128 <h4>Parameters:</h4>
 129 <dl>
 130 <dt>        <code>section</code></dt>
 131 <dd>string - Config file section name</dd>
 132 </dl>
 133 <h4>Returns:</h4>
 134 <dl>
 135 <dt>        list</dt>
 136 <dd>the essid and bssid</dd>
 137 </dl>
 138 </td></tr>
 139 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 140
 141         <tr>
 142             <th bgcolor="#99ccff"
 143                 rowspan="2"
 144                 valign="top"
 145                 align="left"
 146                 width="20%"
 147                 >
 148                 <font color="#000000">
 149                   <a name="get_new_profile"></a>&nbsp;
 150                 </font>
 151             </th>
 152             <th bgcolor="#99ccff"
 153                 valign="top"
 154                 align="left"
 155                 width="80%"
 156                 >
 157                 <font color="#000000">get_new_profile&nbsp;</font>
 158             </th>
 159         </tr>
 160         <tr>
 161         <td>
 162         <pre>
 163 get_new_profile ()
 164 </pre>
 165
 166 <p>Return a blank profile</p>
 167 <h4>Parameters:</h4>
 168 <p>        none</p>
 169 <h4>Returns:</h4>
 170 <dl>
 171 <dt>        dictionary</dt>
 172 <dd>An AP profile with defaults set.</dd>
 173 </dl>
 174 </td></tr>
 175 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 176
 177         <tr>
 178             <th bgcolor="#99ccff"
 179                 rowspan="2"
 180                 valign="top"
 181                 align="left"
 182                 width="20%"
 183                 >
 184                 <font color="#000000">
 185                   <a name="say"></a>&nbsp;
 186                 </font>
 187             </th>
 188             <th bgcolor="#99ccff"
 189                 valign="top"
 190                 align="left"
 191                 width="80%"
 192                 >
 193                 <font color="#000000">say&nbsp;</font>
 194             </th>
 195         </tr>
 196         <tr>
 197         <td>
 198         <pre>
 199 say ( words )
 200 </pre>
 201
 202 <p>Speak feedback message to user</p>
 203 <h4>Parameters:</h4>
 204 <dl>
 205 <dt>        <code>words</code></dt>
 206 <dd>string - Message to speak to user</dd>
 207 </dl>
 208 <h4>Returns:</h4>
 209 <p>        nothing</p>
 210 </td></tr>
 211 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 212
 213         <tr>
 214             <th bgcolor="#99ccff"
 215                 rowspan="2"
 216                 valign="top"
 217                 align="left"
 218                 width="20%"
 219                 >
 220                 <font color="#000000">
 221                   <a name="make_section_name"></a>&nbsp;
 222                 </font>
 223             </th>
 224             <th bgcolor="#99ccff"
 225                 valign="top"
 226                 align="left"
 227                 width="80%"
 228                 >
 229                 <font color="#000000">make_section_name&nbsp;</font>
 230             </th>
 231         </tr>
 232         <tr>
 233         <td>
 234         <pre>
 235 make_section_name ( essid,  bssid )
 236 </pre>
 237
 238 <p>Combine essid and bssid to make a config file section name</p>
 239 <h4>Parameters:</h4>
 240 <dl>
 241 <dt>        <code>essid</code></dt>
 242 <dd>string - AP ESSID</dd>
 243 <dt>        <code>bssid</code></dt>
 244 <dd>string - AP BSSID</dd>
 245 </dl>
 246 <h4>Returns:</h4>
 247 <dl>
 248 <dt>        string</dt>
 249 <dd>the bssid concatenated to a colon, concatenated to the essid</dd>
 250 </dl>
 251 </td></tr>
 252 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 253
 254         <tr>
 255             <th bgcolor="#99ccff"
 256                 rowspan="2"
 257                 valign="top"
 258                 align="left"
 259                 width="20%"
 260                 >
 261                 <font color="#000000">
 262                   <a name="shellcmd"></a>&nbsp;
 263                 </font>
 264             </th>
 265             <th bgcolor="#99ccff"
 266                 valign="top"
 267                 align="left"
 268                 width="80%"
 269                 >
 270                 <font color="#000000">shellcmd&nbsp;</font>
 271             </th>
 272         </tr>
 273         <tr>
 274         <td>
 275         <pre>
 276 shellcmd ( command,  environment=None )
 277 </pre>
 278
 279 <p>Run commands through the shell</p>
 280 <h4>Parameters:</h4>
 281 <dl>
 282 <dt>        <code>command</code></dt>
 283 <dd>tuple - The command and arguments to run.</dd>
 284 <dt>        <code>environment</code></dt>
 285 <dd>dictionary - Environment variables (as keys) and their values.</dd>
 286 </dl>
 287 <h4>Returns:</h4>
 288 <dl>
 289 <dt>        boolean</dt>
 290 <dd>True on success, otherwise, False</dd>
 291 </dl>
 292 </td></tr>
 293 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 294
 295         <tr>
 296             <th bgcolor="#99ccff"
 297                 rowspan="2"
 298                 valign="top"
 299                 align="left"
 300                 width="20%"
 301                 >
 302                 <font color="#000000">
 303                   <a name="set_network_device"></a>&nbsp;
 304                 </font>
 305             </th>
 306             <th bgcolor="#99ccff"
 307                 valign="top"
 308                 align="left"
 309                 width="80%"
 310                 >
 311                 <font color="#000000">set_network_device&nbsp;</font>
 312             </th>
 313         </tr>
 314         <tr>
 315         <td>
 316         <pre>
 317 set_network_device ( device )
 318 </pre>
 319
 320 <p>Sets the interface to the specified network device</p>
 321 <h4>Parameters:</h4>
 322 <dl>
 323 <dt>        <code>device</code></dt>
 324 <dd>string - The network device to use</dd>
 325 </dl>
 326 <h4>Returns:</h4>
 327 <p>        nothing</p>
 328 </td></tr>
 329 </table></td></tr>
 330 </table><table border="0" cellpadding="5" cellspacing="0" width="100%">
 331
 332         <tr>
 333             <th bgcolor="#99ccff"
 334                 rowspan="2"
 335                 valign="top"
 336                 align="left"
 337                 width="20%"
 338                 >
 339                 <font color="#000000">
 340                   <a name="">Classes</a>&nbsp;
 341                 </font>
 342             </th>
 343             <th bgcolor="#99ccff"
 344                 valign="top"
 345                 align="left"
 346                 width="80%"
 347                 >
 348                 <font color="#000000">&nbsp;</font>
 349             </th>
 350         </tr>
 351         <tr>
 352         <td>
 353         <!-- writeDescriptiveList -->
 354 <table border="0" cellpadding="3" cellspacing="0">
 355
 356             <tr>
 357               <td valign="top"><p><a href="wifi-radar.py/StatusWindow.html">StatusWindow</a></p></td>
 358               <td valign="top">
 359 <p>A simple class for putting up a "Please wait" dialog so the user</p>
 360 </td>
 361             </tr>
 362
 363             <tr>
 364               <td valign="top"><p><a href="wifi-radar.py/file_browse_button.html">file_browse_button</a></p></td>
 365               <td valign="top">
 366 <p>Button to allow user to choose a file and put value into specified gtk.Entry</p>
 367 </td>
 368             </tr>
 369
 370             <tr>
 371               <td valign="top"><p><a href="wifi-radar.py/preferences_dialog.html">preferences_dialog</a></p></td>
 372               <td valign="top">
 373 <p>The preferences dialog.  Edits non-profile sections of the config file.</p>
 374 </td>
 375             </tr>
 376
 377             <tr>
 378               <td valign="top"><p><a href="wifi-radar.py/ConnectionManager.html">ConnectionManager</a></p></td>
 379               <td valign="top">
 380 <p>Manage a connection; including reporting connection state,</p>
 381 </td>
 382             </tr>
 383
 384             <tr>
 385               <td valign="top"><p><a href="wifi-radar.py/ConfigFile.html">ConfigFile</a></p></td>
 386               <td valign="top">
 387 <p>Manage the configuration for the application, including reading and writing the config from/to a file.</p>
 388 </td>
 389             </tr>
 390
 391             <tr>
 392               <td valign="top"><p><a href="wifi-radar.py/profile_dialog.html">profile_dialog</a></p></td>
 393               <td valign="top">
 394 <p>Edit and return an AP profile.</p>
 395 </td>
 396             </tr>
 397
 398             <tr>
 399               <td valign="top"><p><a href="wifi-radar.py/about_dialog.html">about_dialog</a></p></td>
 400               <td valign="top">
 401 <p>Manage a GTK About Dialog</p>
 402 </td>
 403             </tr>
 404
 405             <tr>
 406               <td valign="top"><p><a href="wifi-radar.py/ErrorDialog.html">ErrorDialog</a></p></td>
 407               <td valign="top">
 408 <p>Simple dialog to report an error to the user.</p>
 409 </td>
 410             </tr>
 411
 412             <tr>
 413               <td valign="top"><p><a href="wifi-radar.py/radar_window.html">radar_window</a></p></td>
 414               <td valign="top">
 415 <p>The main user interface window for WiFi Radar.  This class also is the control</p>
 416 </td>
 417             </tr>
 418             </table></td></tr>
 419 </table>
 420         </td>
 421         </tr>
 422         </table>
 423
 424     <hr>
 425
 426     <font size="-2"><i>This document was automatically generated
 427     Sun Apr 19 14:31:33 2009 by <a
 428     href="http://happydoc.sourceforge.net">HappyDoc</a> version
 429     3.1</i></font>
 430
 431   </body>
 432 </html>
 433