FireAlarm version 0.3 README ---------------------------- Please read this file before running FireAlarm for the first time! ---------------------------- INTRODUCTION: FireAlarm version 0.3 (FireAlarm) is a program that listens to /dev/audio (an audio input device, such as a microphone) and tries to detect the sound of a fire alarm sounding. If it hears a fire alarm, it warns the user. FireAlarm is useful to people who can not hear well and therefore can't hear their fire alarm when it goes off. INSTALL: To install FireAlarm, you need the standard C libraries and libSDL, and ncurses. To install FireAlarm, unpack to archive, cd to the FireAlarm directory, and then type: make This will compile FireAlarm for you. Type ./firealarm to run. USAGE: Using FireAlarm version 0.3 is simple. In a terminal, cd to the directory that has FireAlarm in it and type: ./firealarm The options for FireAlarm version 0.2 are below: --help print help information --outfile {file} save any data to {file} instead of the screen --listendev {dev} listen for firealarm on {dev} instead of /dev/audio --test run some simple tests to make sure FireAlarm can run on your computer. Warns of any problems. --quite Runs in silent mode. Use if launching from start-up scripts. --sensitivity {sen} set mic sensitivity to {sen}. Try changing the sensitivity if FireAlarm isn't detecting a firealarm when you know it should, or if you are getting false alarms. When FireAlarm is running in non-silent mode, you can press p to save the current transform data or press q to quit. IMPROVEMENTS IN THIS VERSION: The following improvements have been made in FireAlarm 0.3 over FireAlarm 0.2: - Improved interactive mode by using ncurses - Added --quite switch - Code cleanups The following improvements have been made in FireAlarm 0.2 over FireAlarm 0.1: - The keyboard input has been improved. FireAlarm no longer stops listening to the keyboard if keys are pressed too quickly. - Plays a warning sound if firealarm is heard. - No longer dies with a Segmentation Fault if no input file is given when FireAlarm starts. - Added a default output file to be used if no output file is given. - Cleaned up the code in some areas. - Fixed a number of grammer errors in FireAlarms messages. - FireAlarm now gives better feedback when a button is pressed. - Sensitivity can now be changed - Added --test which can help fix problems running FireAlarm - A (very) small number of other bug fixes. AURTHORS: Tim Greer and Ethan Greer LISCENSE: This software is released under the GNU General Public License. FILES: This archive contains: Makefile the makefile used by make (or gmake if compiling on BSD) main.c the source code (in standard C, compile with gcc) README this file warningsound.wav the warning sound FireAlarm plays. Currently a phaser sound.