HappyDoc Generated Documentation wifi-radar.py
Functions   
  scanning_thread 
scanning_thread (
        confFile,
        apQueue,
        commandQueue,
        logger,
        exit_event,
        )

Scan for a limited time and return AP names and bssid found. Access points we find will be put on the outgoing Queue, apQueue.

Parameters:

confFile
ConfigFile - Config file object
apQueue
Queue - Queue on which to put AP profiles
commandQueue
Queue - Queue from which to read commands
logger
Logger - Python's logging facility

Returns:

nothing

  split_section_name 
split_section_name ( section )

Split a config file section name into an essid and a bssid

Parameters:

section
string - Config file section name

Returns:

list
the essid and bssid
  get_new_profile 
get_new_profile ()

Return a blank profile

Parameters:

none

Returns:

dictionary
An AP profile with defaults set.
  say 
say ( words )

Speak feedback message to user

Parameters:

words
string - Message to speak to user

Returns:

nothing

  get_network_device 
get_network_device ( device )

Gets the network interface device

Parameters:

device
string - The proposed network device to use

Returns:

string
The actual network device to use
  shellcmd 
shellcmd ( command,  environment=None )

Run commands through the shell

Parameters:

command
tuple - The command and arguments to run.
environment
dictionary - Environment variables (as keys) and their values.

Returns:

boolean
True on success, otherwise, False
  make_section_name 
make_section_name ( essid,  bssid )

Combine essid and bssid to make a config file section name

Parameters:

essid
string - AP ESSID
bssid
string - AP BSSID

Returns:

string
the bssid concatenated to a colon, concatenated to the essid
Classes   

StatusWindow

A simple class for putting up a "Please wait" dialog so the user

file_browse_button

Button to allow user to choose a file and put value into specified gtk.Entry

preferences_dialog

The preferences dialog. Edits non-profile sections of the config file.

ConnectionManager

Manage a connection; including reporting connection state,

ConfigFile

Manage the configuration for the application, including reading and writing the config from/to a file.

profile_dialog

Edit and return an AP profile.

about_dialog

Manage a GTK About Dialog

ErrorDialog

Simple dialog to report an error to the user.

radar_window

The main user interface window for WiFi Radar. This class also is the control


This document was automatically generated Thu May 21 05:32:36 2009 by HappyDoc version 3.1