About
-----
Wireless Access Point Utilites for Unix - it's a set of utilites to configure
and monitor Wireless Access Points in Unix using SNMP protocol. Utilites
are known to compile and run under Linux, FreeBSD, NetBSD, MacOS-X, AIX,
QNX and OpenBSD.

The software was initially written by Roman Festchook
(  ) without any help from manufacturers
and released under the terms GNU General Public License version 2.0.
A copy of the license file is included with this distribution package.

The project also has a number of contributions, thanks to whose this
software has grown significantly; for a list of them, see files "THANKS"
and "ChangeLog".

As for version 1.2 Wireless Access Point Utilites for Unix include three utils:

ap-config: config and get stats from AP:
	    setting bridging, wireless and ip options, WEP encryption,
		mac authorization, radio signal power, and communities to
		restrict access to AP, enabling/disabling antennas,
		hiding ESSID in broadcast messages;
	    device test mode;
	    getting info about AP sofware and hardware, dynamically updated
		ethernet and wireless ports statistics, list of associated
		stations and visible APs (option to save mac addresses of
		current associated stations to file);
	    executing commands on AP;
	config and get stats from devices that support 
	    MIB-II, IEEE 802.11 MIB and NWN DOT11EXT MIB:
	    setting bridging and wireless options, WEP encryption,
		mac authorization, communities to restrict access to AP,
		enabling/disabling antennas;
	    getting info about AP sofware and hardware, dynamically updated 
		wireless port statistics, information about latest events
		and errors, list of current associated stations	with info
		about signal quality and station activity (option to save
		mac addresses of associated stations to file);
	search for connected APs;
	nice and portable ncurses-based user interface with context-help
		navigation menus, floating drop-down menus to choose from
		options list, options file to store connect options and
		subshell.
	
ap-mrtg: to get stat from AP (ATMEL based) and return it in MRTG parseable format:
	getting ethernet statistics in bytes, wireless statistics in packets,
		associated stations number and Link Quality/Signal Strenght
		stats from AP in client mode.
	
ap-trapd: to receive, parse and log trap messages from AP (ATMEL based):
	log data using standart syslogd;
	running by not privileged user;
	listening on the specified interface (only on Linux).

Supported Hardware
------------------
ap-utils support Atmel chipset based Access Points with ATMEL private MIB
with enterprises ID 410 (ATMEL410), Access Points with newer ATMEL private
MIB with enterprises ID 12350 (ATMEL12350) such as Netgear ME102 and Tellus
A14, and No Wires Needed APs with IEEE 802.11 MIB and NWN DOT11EXT MIB
(NWN).
You can find Known/Reported-to-work hardware in the table below.
If you have had success with ap-utils working with a hardware thats
not in the table below, please report.
Please, if possible, include informations from the ap-config's "sysinfo"
screen in your report.
Also, if possible, please send the MIB file that comes with your device.
This may result in supporting more options in ap-config in the future!
The file may look like 'AT76C510.mib' (in case of ATMEL-based APs),
and usually comes with your SNMP management utility for Windows.

+------------------------------------------------------------------------------+
|				Supported Access Points			       |
+------------------------------------------------------------------------------+
| Manufacturer			| Models		| Type		       |
+-------------------------------+-----------------------+----------------------+
| Global Sun			| ProWave GL2411AP	| ATMEL410	       |
| Linksys	    		| WAP11 pre2 version	| ATMEL410	       |
| SMC		    		| MC2655W		| ATMEL410	       |
| Netgear	    		| ME102		  	| ATMEL12350, ATMEL410 |
| Eumitcom	    		| WA3001A		| ATMEL410	       |
| Edimax	    		| EW-7205		| ATMEL410	       |
| Target	    		| WLAP 24212		| ATMEL410 	       |
| Micronet          		| SP918			| ATMEL410	       |
| Smartbridges	    		| airPoint, airBridge	| ATMEL410	       |
| Belkin Components 		| F5D6130		| ATMEL410	       |
| GemTek	    		| TEW-210APB		| ATMEL410	       |
| GemTek            		| WX-1500		| NWN		       |
| Intellinet        		| AP, Wireless Bridge	| ATMEL410	       |
| D-Link	    		| DWL 900AP		| ATMEL410	       |
| D-Link	    		| DWL 1000AP		| NWN		       |
| WLink Syst. (D-Link subs.)	| Wen-2021		| ATMEL410	       |
| Advantek Networks             | AWN-AP128		| ATMEL410	       |
| Compex	    		| WavePort WP11		| NWN		       |
| Zoom		    		| ZoomAir11AP		| NWN		       |
| Telecom	    		| T-Sinus 130X		| ATMEL410	       |
| Ovislink          		| Airlive WL-1100AP	| ATMEL410	       |
| CC&C Technologies 		| Access Point		| ATMEL410	       |
| Compaq	    		| WL-400		| NWN (mostly works)   |
| Asus		    		| WL-300		| ATMEL410	       |
| Topcom	    		| SkyLanR@cer 500	| ATMEL410	       |
| Fiberline			| WL-1200AP		| ATMEL12350	       |
| CNet				| CNAP-711		| ATMEL410	       |
| Yakumo			| Access Point		| ATMEL410	       |
| Dynalink (Askey)		| RTW020		| ATMEL410	       |
| Acer				| Warplink EJA-A	| NWN		       |
| Svec				| FD1811		| ATMEL12350, ATMEL410 |
| Tellus Group Corp           	| A14			| ATMEL12350           |
| Wline                         | A14			| ATMEL12350	       |
| i-Tec                         | i-Tec AP SILVER	| ATMEL410             |
| i-Tec                         | i-Tec AP GOLD		| ATMEL410             |
| Infosmart                   	| INAP88		| ATMEL410             |
| Ark                        	| SOHO-WLAP		| ATMEL410             |
| Svec                          | SOHO-WLAP		| ATMEL410	       |
| GigaFast                      | WF711-AP		| ATMEL12350           |
| Cameo Communications          | WLB-2000/2001         | ATMEL410	       |
| Wline                         | W-2000                | ATMEL410             |
+-------------------------------+-----------------------+----------------------+

Please note that although many of these devices may use the same MIB enterprise
identification, the actual MIBs may slightly differ, depending on whether
the manufacturer has decided upon hardware modifications.
In ap-config, an effort has been made to only include functionality
for features that are common to 2 or more MIBs with the same enterprise
ID. If you have qualms, then please send us the MIB file that came
with your device!

WARNING 1: There actually exist two different kinds of ATMEL private MIBs,
regardless of its enterprise ID - each with a different set of operational
modes.
One type the private MIB comes with is often referred to as "Access Point"
firmware, often marked with shortcut "AP". Another one is referred to as
"Wireless Adapter firmware", marked with shortcut "WA".
"WA" firmware has questionable advantage that it is claimed to allow APs
equipped with this firmware to connect with non-ATMEL-based APs of other
manufacturers using "AP-client (Infrastructure)" mode (in reality, this is,
unfortunately, often false), at cost of supporting no true "AP" mode
(only Ad-Hoc and AP-client modes are available).

Whenever you can, use firmware labelled as "AP" and not "WA".
"AP" version supports most networking modes, compared to "WA" version.
MIBs AND FIRMWARES WITH "WA" LABEL ARE NOT SUPPORTED WITH AP-UTILS!
They may appear to _partially_ work with ap-utils, but you
can cause harm to your AP if you use ap-utils with such firmware.
Do not complain if you use ap-utils with such firmware and it damages
your AP!

WARNING 2: Users of Tellus A14 and its OEM versions (Wline A14, Veriplus
WL-A14, etc. - ATMEL12350 AP "types"): Beware. Firmwares up to (including)
version 0.2.2.19 for these APs contain a SERIOUS BUG that may
result in unpredictable and persistent lock-up of your AP, when configured
over SNMP or even via its web interface. There's unfortunately no way
of how to "resurrect" such a locked-up AP - the only option is to return
the AP to its supplier for replacement.
To be on the safe side, we recommend everyone to upgrade to any firmware
version above 0.2.2.19. At the time of this writing,
you should be able to download firmware v. 0.2.2.21 including
the corresponding TFTP utility for example from the following link:

http://www.sparklan.com/download.htm

or send your AP to its supplier for firmware replacement in case
he's able to supply you with customarily enhanced firmware version
above 0.2.2.19.

Frequently Asked Questions
--------------------------

I got an AP and I would like ap-utils to support it (it is not on the
---------------------------------------------------------------------
list above)
-----------
The device has to be either ATMEL- or NWN-based. The first good sign
of a chance it could be supported by the ap-utils, is the presence
of file 'AT76C510.mib', that gets installed along with the original
Windows-based setup utility.
Try to install the accompanying Windows SNMP setup utility, and
browse the directory to which you have got it installed.
If you find the mentioned file, send this file via e-mail
to <aputils-wmibs at cedric dot vabo dot cz> or <roma at polesye dot net>.
Chances are, that this file matches more or less the MIBs
of other devices already being supported by ap-utils, and thus the
utility code can be tailored accordingly to support your AP
in as broad number of its features as possible.

Where to get more information
-----------------------------
You can find info about utils from this README and from man pages
for utilites; as well as in INSTALL and TODO files at toplevel directory.
Additional info and useful links may be found in the Documentation
directory of this package and on our web page http://ap-utils.polesye.net/ .
We also run maillist to discuss any related topics - for more info please
visit http://ap-utils.polesye.net/ .

Contributing & reporting problems
---------------------------------
Any help in developing, bugfixing and testing is welcome. Also any
additional documentation, free hardware to support this project and job offers
are greatly welcome.
Please send your comments, if any, to my email -
roma at polesye.net or to the maillist.

Before sending bugreports please be sure to read docs (firstly, README and FAQ)
and upgrade to the latest version of ap-utils. If problem still exists, then
please send a detailed description of your problem to the maillist.
Include the version of the program, the operating system that you are
using, the compiler and compiler flags used to compile the program (if
you know them), what kind of distribution you are using (in case of a GNU/Linux
system).
If the program crashed and produces a core dump, please provide a
stack trace of the program.
You can do this by running dbx or gdb like this:
    gdb <utility_name> core
    (gdb) where

