Last Update: March 21, 2015

Documentation

WiFi Radar 2.0 User Manual Appendix

by Sean Robinson

Configuration File

This is a section-by-section, option-by-option description of the config file. Options under each section are in alphabetical order.

DEFAULT

This is where general options are saved.

auto_profile_order

This is a list of the sections which contain profile information.

commit_required

Set this to True if iwconfig commit should be used after each iwconfig command (default: False).

ifconfig_command

This is the command to use when manipulating the IP settings of the NIC (default: /sbin/ifconfig).

ifup_required

Set this to True if the NIC must be brought up (i.e. ifconfig wlan0 up) before scanning will work (default: False).

interface

This should be set to the name of your NIC (e.g. eth1 or wlan0) or auto_detect (default: auto_detect). With auto_detect, WiFi Radar will try to use the first wireless-capable NIC it finds.

iwconfig_command

This is the command to use when manipulating the Wireless Extension settings (e.g. encryption key) of the NIC (default: /sbin/iwconfig).

iwlist_command

This is the command to use for scanning for access points (default: /sbin/iwlist).

logfile

This is the location of the log file (default: /var/log/wifi-radar.log).

loglevel

This sets the verbosity of messages sent to the logfile (default: 50). The number given here is a threshold value, only those messages emitted by WiFi Radar which exceed loglevel will be written to the logfile. So, the default value of 50 means to only save the most critical messages and a loglevel of 0 means to save all messages to the logfile.

route_command

The command to use to set up network routing if DHCP is not used (default: /sbin/route).

speak_command

The command to use to speak status messages (default: /usr/bin/say).

speak_up

Set to True to use the speak command (default: False).

version

The version of WiFi Radar which created this configuration file (default: 0.0.0).

DHCP

args

This is the list of parameters to pass to the DHCP client when acquiring a lease (i.e. setting up a connection) (default: -D -o -i dhcp_client -t %(timeout)s).

command

The command to use to automatically set up the IP networking (default: /sbin/dhcpcd).

kill_args

This is the list of parameters to pass to the DHCP client when disconnecting from a network (default: -k).

pidfile

This is where the DHCP client saves its state info (default: /etc/dhcpc/dhcpcd-%(interface)s.pid). This file is used if the standard DHCP disconnect does not work and WiFi Radar must kill the client on its own.

timeout

The time (in seconds) to allow the DHCP client to try to acquire a lease (default: 30). If the DHCP client does not stop itself after this length of time plus five seconds, WiFi Radar will force the client to end.

WPA

args

This is the list of parameters to pass to the WPA supplicant when associating with the network (default: -B -i %(interface)s -c %(configuration)s -D %(driver)s -P %(pidfile)s).

command

The command to use as the WPA supplicant (default: /usr/sbin/wpa_supplicant).

configuration

The WPA supplicant's configuration file (default: /etc/wpa_supplicant.conf).

driver

The WPA supplicant driver to use (default: wext).

kill_command

The command to use to end the WPA supplicant (default: ). The default is an empty value.

pidfile

Specify where the WPA supplicant saves its state info (default: /var/run/wpa_supplicant.pid).

Profile

The general pattern used to store access point (AP) profile information is ESSID:BSSID. ESSID is the AP name (e.g. WinterPalace, British Open Pub) and BSSID is the AP hardware address. The BSSID may be blank if the profile is a roaming profile. So a sample profile section name is WinterPalace:

available

This is used internally by WiFi Radar to indicate whether an access point is currently detected, it should always be False in the configuration file (default: False).

bssid

This is a copy of the BSSID in the section name and is used to calculate the section name (default: 00:00:00:00:00:00). It may be blank in a roaming profile.

channel

This is the channel to use to connect with the network (default: auto).

con_postscript

This is the command to run after connecting to the network (default: ).

con_prescript

This is the command to run before connecting to the network (default: ).

dis_postscript

This is the command to run after disconnecting from the network (default: ).

dis_prescript

This is the command to run before disconnecting from the network (default: ).

dns1

The primary DNS server (default: ). Only used when not using DHCP

dns2

The secondary DNS server (default: ). Only used when not using DHCP

domain

The domain (e.g. winterpalace.org) of the network (default: ). Only used when not using DHCP

encrypted

Whether the network is encrypted (default: False).

essid

The network name (default: ). This is a copy of the ESSID in the section name and is used to calculate the section name.

gateway

The IP address of the network gateway to other networks (default: ). Only used when not using DHCP

ip

The fixed IP address to use on this network (default: ). Only used when not using DHCP

key

The WEP encryption key (default: ). This is not used with WPA.

known

This is used internally by WiFi Radar to indicate whether an access point has a configured profile, it should always be True in the configuration file (default: True).

mode

This is the association mode to use (default: auto). This is not the same as the mode reported by the AP. In fact, this should be a reflection of the AP mode (i.e. Master mode AP should be Managed mode here).

netmask

The netmask (e.g. 192.168.1.0/255) to use (default: ). Only used when not using DHCP

protocol

The WiFi protocol used by the access point (AP) (default: g). This is only used as a place to store the protocol read from the AP. This will be overwritten the next time the AP is scanned.

roaming

Set to True if this is a roaming profile (default: False).

security

This should/will be the security mode (i.e. open or restricted), but as it currently causes crashes, it is not used (default: ).

signal

The signal level read from the access point (AP) (default: 0). This is used internally by WiFi Radar, the value will be overwritten each time WiFi Radar is run.

use_dhcp

When set to True, WiFi Radar will ask the DHCP client to configure the IP settings (default: True).

use_wpa

When set to True, WiFi Radar will ask the WPA supplicant to handle associating with the access point (default: False).

wpa_driver

The card driver the WPA supplicant should use (default: ).