<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>HappyDoc Generated Documentation</title>
</head>
<body bgcolor="#ffffff">
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">HappyDoc Generated Documentation</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">wifi-radar.py</font>
</th>
</tr>
<tr>
<td>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Functions</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="scanning_thread"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">scanning_thread </font>
</th>
</tr>
<tr>
<td>
<pre>
scanning_thread (
confFile,
apQueue,
commandQueue,
logger,
exit_event,
)
</pre>
<p>Scan for a limited time and return AP names and bssid found.
Access points we find will be put on the outgoing Queue, apQueue.</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>confFile</code></dt>
<dd>ConfigFile - Config file object</dd>
<dt> <code>apQueue</code></dt>
<dd>Queue - Queue on which to put AP profiles</dd>
<dt> <code>commandQueue</code></dt>
<dd>Queue - Queue from which to read commands</dd>
<dt> <code>logger</code></dt>
<dd>Logger - Python's logging facility</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="split_section_name"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">split_section_name </font>
</th>
</tr>
<tr>
<td>
<pre>
split_section_name ( section )
</pre>
<p>Split a config file section name into an essid and a bssid</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>section</code></dt>
<dd>string - Config file section name</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> list</dt>
<dd>the essid and bssid</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="get_new_profile"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">get_new_profile </font>
</th>
</tr>
<tr>
<td>
<pre>
get_new_profile ()
</pre>
<p>Return a blank profile</p>
<h4>Parameters:</h4>
<p> none</p>
<h4>Returns:</h4>
<dl>
<dt> dictionary</dt>
<dd>An AP profile with defaults set.</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="say"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">say </font>
</th>
</tr>
<tr>
<td>
<pre>
say ( words )
</pre>
<p>Speak feedback message to user</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>words</code></dt>
<dd>string - Message to speak to user</dd>
</dl>
<h4>Returns:</h4>
<p> nothing</p>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="get_network_device"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">get_network_device </font>
</th>
</tr>
<tr>
<td>
<pre>
get_network_device ( device )
</pre>
<p>Gets the network interface device</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>device</code></dt>
<dd>string - The proposed network device to use</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> string</dt>
<dd>The actual network device to use</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="shellcmd"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">shellcmd </font>
</th>
</tr>
<tr>
<td>
<pre>
shellcmd ( command, environment=None )
</pre>
<p>Run commands through the shell</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>command</code></dt>
<dd>tuple - The command and arguments to run.</dd>
<dt> <code>environment</code></dt>
<dd>dictionary - Environment variables (as keys) and their values.</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> boolean</dt>
<dd>True on success, otherwise, False</dd>
</dl>
</td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="make_section_name"></a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">make_section_name </font>
</th>
</tr>
<tr>
<td>
<pre>
make_section_name ( essid, bssid )
</pre>
<p>Combine essid and bssid to make a config file section name</p>
<h4>Parameters:</h4>
<dl>
<dt> <code>essid</code></dt>
<dd>string - AP ESSID</dd>
<dt> <code>bssid</code></dt>
<dd>string - AP BSSID</dd>
</dl>
<h4>Returns:</h4>
<dl>
<dt> string</dt>
<dd>the bssid concatenated to a colon, concatenated to the essid</dd>
</dl>
</td></tr>
</table></td></tr>
</table><table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="">Classes</a>
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000"> </font>
</th>
</tr>
<tr>
<td>
<!-- writeDescriptiveList -->
<table border="0" cellpadding="3" cellspacing="0">
<tr>
<td valign="top"><p><a href="wifi-radar.py/StatusWindow.html">StatusWindow</a></p></td>
<td valign="top">
<p>A simple class for putting up a "Please wait" dialog so the user</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/file_browse_button.html">file_browse_button</a></p></td>
<td valign="top">
<p>Button to allow user to choose a file and put value into specified gtk.Entry</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/preferences_dialog.html">preferences_dialog</a></p></td>
<td valign="top">
<p>The preferences dialog. Edits non-profile sections of the config file.</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/ConnectionManager.html">ConnectionManager</a></p></td>
<td valign="top">
<p>Manage a connection; including reporting connection state,</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/ConfigFile.html">ConfigFile</a></p></td>
<td valign="top">
<p>Manage the configuration for the application, including reading and writing the config from/to a file.</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/profile_dialog.html">profile_dialog</a></p></td>
<td valign="top">
<p>Edit and return an AP profile.</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/about_dialog.html">about_dialog</a></p></td>
<td valign="top">
<p>Manage a GTK About Dialog</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/ErrorDialog.html">ErrorDialog</a></p></td>
<td valign="top">
<p>Simple dialog to report an error to the user.</p>
</td>
</tr>
<tr>
<td valign="top"><p><a href="wifi-radar.py/radar_window.html">radar_window</a></p></td>
<td valign="top">
<p>The main user interface window for WiFi Radar. This class also is the control</p>
</td>
</tr>
</table></td></tr>
</table>
</td>
</tr>
</table>
<hr>
<font size="-2"><i>This document was automatically generated
Thu May 21 05:32:36 2009 by <a
href="http://happydoc.sourceforge.net">HappyDoc</a> version
3.1</i></font>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f6a709d1edccf793d4ecae90b649467b
>
files
>
19
