Add app_alarmreceiver (bug #1783)

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@3264 f38db490-d61c-443f-a65b-d21fe96a405b

3 files changed, 934 insertions, 1 deletions

diff --git a/apps/Makefile b/apps/Makefile
index f0a11b8c6..5f177c19c 100755
--- a/apps/Makefile
+++ b/apps/Makefile
@@ -28,7 +28,7 @@ APPS=app_dial.so app_playback.so app_voicemail.so app_directory.so app_mp3.so\
      app_setcdruserfield.so app_random.so app_ices.so app_eval.so \
      app_nbscat.so app_sendtext.so app_exec.so app_sms.so \
      app_groupcount.so app_txtcidname.so app_controlplayback.so \
-	 app_talkdetect.so
+     app_talkdetect.so app_alarmreceiver.so
 
 ifneq (${OSARCH},Darwin)
 APPS+=app_intercom.so
diff --git a/apps/app_alarmreceiver.c b/apps/app_alarmreceiver.c
new file mode 100755
index 000000000..b8300f934
--- /dev/null
+++ b/apps/app_alarmreceiver.c
@@ -0,0 +1,857 @@
+/*
+ * Asterisk -- A telephony toolkit for Linux.
+ *
+ * Central Station Alarm receiver for Ademco Contact ID  
+ * 
+ * Copyright (C) 2004 Steve Rodgers
+ *
+ * Steve Rodgers <hwstar@rodgers.sdcoxmail.com>
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License
+ *
+ * *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** 
+ *
+ * Use at your own risk. Please consult the GNU GPL license document included with Asterisk details. *
+ *
+ * *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING *** WARNING ***
+ *
+ */ 
+ 
+#include <asterisk/lock.h>
+#include <asterisk/file.h>
+#include <asterisk/logger.h>
+#include <asterisk/channel.h>
+#include <asterisk/pbx.h>
+#include <asterisk/module.h>
+#include <asterisk/translate.h>
+#include <asterisk/ulaw.h>
+#include <asterisk/options.h>
+#include <asterisk/app.h>
+#include <asterisk/dsp.h>
+#include <asterisk/config.h>
+#include <asterisk/localtime.h>
+#include <asterisk/callerid.h>
+#include <asterisk/astdb.h>
+#include <string.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <math.h>
+#include <sys/wait.h>
+#include <unistd.h>
+#include <pthread.h>
+#include <sys/time.h>
+
+#define ALMRCV_CONFIG "alarmreceiver.conf"
+#define ADEMCO_CONTACT_ID "ADEMCO_CONTACT_ID"
+
+struct event_node{
+	char data[17];
+	struct event_node *next;
+};
+
+typedef struct event_node event_node_t;
+
+static char *tdesc = "Alarm Receiver for Asterisk";
+
+static char *app = "AlarmReceiver";
+
+static char *synopsis = "Provide support for receving alarm reports from a burglar or fire alarm panel\n";
+static char *descrip =
+"Alarm receiver application for Asterisk. Only 1 signalling format is supported at this time:\n"
+"Ademco Contact ID. This application should be called whenever there is an alarm panel calling in\n"
+"to dump its events. The application will handshake with the alarm panel, and receive events,\n"
+"validate them, handshake them, and store them until the panel hangs up. Once the panel hangs up,\n"
+"the application will run the command line specified by the eventcmd setting in alarmreceiver.conf\n"
+"and pipe the events to the standard input of the application. Alarmreceiver.conf also contains settings\n"
+"for DTMF timing, and for the loudness of the acknowledgement tones.\n";
+
+/* Config Variables */
+
+static int fdtimeout = 2000;
+static int sdtimeout = 200; 
+static int toneloudness = 4096;
+static int log_individual_events = 0;
+static char event_spool_dir[128] = {'\0'};
+static char event_app[128] = {'\0'};
+static char db_family[128] = {'\0'};
+static char time_stamp_format[128] = {"%a %b %d, %Y @ %H:%M:%S %Z"};
+
+
+/* Misc variables */
+
+	
+static char event_file[14] = "/event-XXXXXX";
+
+
+
+STANDARD_LOCAL_USER;
+
+LOCAL_USER_DECL;
+
+/*
+* Attempt to access a database variable and increment it,
+* provided that the user defined db-family in alarmreceiver.conf
+* The alarmreceiver app will write statistics to a few variables
+* in this family if it is defined. If the new key doesn't exist in the
+* family, then create it and set its value to 1.
+*/
+
+static void database_increment( char *key )
+{
+	int res = 0;
+	unsigned v;
+	char value[16];
+	
+	
+	if(!strlen(db_family))
+		return; /* If not defined, don't do anything */
+	
+	res = ast_db_get(db_family, key, value, sizeof(value) - 1);
+	
+	if(res){
+		if(option_verbose >= 4)
+			ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Creating database entry %s and setting to 1\n", key);
+		/* Guess we have to create it */
+		res = ast_db_put(db_family, key, "1");
+		return;
+	}
+	
+	sscanf(value, "%u", &v);
+	v++;
+	
+	if(option_verbose >= 4)
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: New value for %s: %u\n", key, v);
+		
+	snprintf(value, sizeof(value) - 1, "%u", v);
+	
+	res = ast_db_put(db_family, key, value);
+	
+	if((res)&&(option_verbose >= 4))
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: database_increment write error");
+	
+	return;	
+}
+
+
+/*
+* Build a MuLaw data block for a single frequency tone
+*/
+
+static void make_tone_burst(unsigned char *data, float freq, float loudness, int len, int *x)
+{
+	int     i;
+	float   val;
+                                                                                                                                    
+        for(i = 0; i < len; i++){
+		val = loudness * sin((freq * 2.0 * M_PI * (*x)++)/8000.0);
+		data[i] = AST_LIN2MU((int)val);
+	}
+
+	/* wrap back around from 8000 */
+
+	if (*x >= 8000) *x = 0;
+	return;
+}
+
+/*
+* Send a single tone burst for a specifed duration and frequency. 
+* Returns 0 if successful
+*/
+
+static int send_tone_burst(struct ast_channel *chan, float freq, int duration, int tldn)
+{
+	int res = 0;
+	int i = 0;
+	int x = 0;
+	struct ast_frame *f, wf;
+	
+	struct {
+		unsigned char offset[AST_FRIENDLY_OFFSET];
+		unsigned char buf[640];
+	} tone_block;
+
+	for(;;)
+	{
+	
+		if (ast_waitfor(chan, -1) < 0){
+			res = -1;
+			break;
+		}
+		
+		f = ast_read(chan);
+		if (!f){
+			res = -1;
+			break;
+		}
+		
+		if (f->frametype == AST_FRAME_VOICE) {
+			wf.frametype = AST_FRAME_VOICE;
+			wf.subclass = AST_FORMAT_ULAW;
+			wf.offset = AST_FRIENDLY_OFFSET;
+			wf.mallocd = 0;
+			wf.data = tone_block.buf;
+			wf.datalen = f->datalen;
+			wf.samples = wf.datalen;
+			
+			make_tone_burst(tone_block.buf, freq, (float) tldn, wf.datalen, &x);
+
+			i += wf.datalen / 8;
+			if (i > duration) {
+				break;
+			}
+			if (ast_write(chan, &wf)){
+				if(option_verbose >= 4)
+					ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Failed to write frame on %s\n", chan->name);
+				ast_log(LOG_WARNING, "AlarmReceiver Failed to write frame on %s\n",chan->name);
+				res = -1;
+				break;
+			}
+		}
+		
+		ast_frfree(f);
+	}
+	return res;
+}
+
+/*
+* Return the difference in milliseconds between two timeval structs
+*/
+
+static int ms_diff(struct timeval *tv1, struct timeval *tv2){
+
+	int	ms;
+	
+	ms = (tv1->tv_sec - tv2->tv_sec) * 1000;
+	ms += (tv1->tv_usec - tv2->tv_usec) / 1000;
+	
+	return(ms);
+}
+
+/*
+* Receive a string of DTMF digits where the length of the digit string is known in advance. Do not give preferential
+* treatment to any digit value, and allow separate time out values to be specified for the first digit and all subsequent
+* digits.
+*
+* Returns 0 if all digits successfully received.
+* Returns 1 if a digit time out occurred
+* Returns -1 if the caller hung up or there was a channel error.
+*
+*/
+
+static int receive_dtmf_digits(struct ast_channel *chan, char *digit_string, int length, int fdto, int sdto)
+{
+	int res = 0;
+	int i = 0;
+	int r;
+	struct ast_frame *f;
+	struct timeval now, lastdigittime;
+	
+	gettimeofday(&lastdigittime,NULL);
+	for(;;){
+		gettimeofday(&now,NULL);
+		
+		  /* if outa time, leave */
+		if (ms_diff(&now,&lastdigittime) > 
+		    ((i > 0) ? sdto : fdto)){
+			if(option_verbose >= 4)
+				ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: DTMF Digit Timeout on %s\n", chan->name);
+				
+			ast_log(LOG_DEBUG,"AlarmReceiver: DTMF timeout on chan %s\n",chan->name);
+				
+			res = 1;
+			break;
+		}
+		
+		if ((r = ast_waitfor(chan, -1) < 0)) {
+			ast_log(LOG_DEBUG, "Waitfor returned %d\n", r);
+			continue;
+		}
+			
+		f = ast_read(chan);
+		
+		if (f == NULL){
+			res = -1;
+			break;
+		}
+		
+		/* If they hung up, leave */
+		if ((f->frametype == AST_FRAME_CONTROL) &&
+		    (f->subclass == AST_CONTROL_HANGUP)){
+			ast_frfree(f);
+			res = -1;
+			break;
+		}
+		
+		/* if not DTMF, just do it again */
+		if (f->frametype != AST_FRAME_DTMF){
+			ast_frfree(f);
+			continue;
+		}
+
+		digit_string[i++] = f->subclass;  /* save digit */
+		
+		ast_frfree(f);
+		
+		/* If we have all the digits we expect, leave */
+		if(i >= length)
+			break;
+		
+		gettimeofday(&lastdigittime,NULL);
+	}
+	
+	digit_string[i] = '\0'; /* Nul terminate the end of the digit string */
+	return res;
+
+}
+
+/*
+* Write the metadata to the log file
+*/
+
+static int write_metadata( FILE *logfile, char *signalling_type, struct ast_channel *chan)
+{
+	int res = 0;
+	time_t t;
+	struct tm now;
+	char *cl,*cn;
+	char workstring[80];
+	char timestamp[80];
+	
+	/* Extract the caller ID location */
+	
+	strncpy(workstring, chan->callerid, sizeof(workstring) - 1);
+	workstring[sizeof(workstring) - 1] = '\0';
+	
+	ast_callerid_parse(workstring, &cn, &cl);
+	if (cl) 
+		ast_shrink_phone_number(cl);
+                
+
+	/* Get the current time */
+		
+	time(&t);
+	ast_localtime(&t, &now, NULL);
+	
+	/* Format the time */
+	
+	strftime(timestamp, sizeof(timestamp), time_stamp_format, &now); 
+
+	
+	res = fprintf(logfile, "\n\n[metadata]\n\n");
+	
+	if(res >= 0)
+		res = fprintf(logfile, "PROTOCOL=%s\n", signalling_type);
+		
+	if(res >= 0)	
+		res = fprintf(logfile, "CALLINGFROM=%s\n", (!cl) ? "<unknown>" : cl);
+		
+	if(res >- 0)
+		res = fprintf(logfile, "CALLERNAME=%s\n", (!cn) ? "<unknown>" : cn);
+		
+	if(res >= 0)
+		res = fprintf(logfile, "TIMESTAMP=%s\n\n", timestamp);
+	
+	if(res >= 0)
+		res = fprintf(logfile, "[events]\n\n");
+	
+	if(res < 0){
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: can't write metadata\n");	
+		
+		ast_log(LOG_DEBUG,"AlarmReceiver: can't write metadata\n");
+	}
+	else
+		res = 0;
+
+	return res;
+}
+
+/*
+* Write a single event to the log file
+*/
+
+static int write_event( FILE *logfile,  event_node_t *event)
+{
+	int res = 0;
+
+	if( fprintf(logfile, "%s\n", event->data) < 0)
+		res = -1;
+			
+	return res;
+}
+
+
+/*
+* If we are configured to log events, do so here.
+*
+*/
+
+static int log_events(struct ast_channel *chan,  char *signalling_type, event_node_t *event)
+{
+
+	int res = 0;
+	char workstring[sizeof(event_spool_dir)+sizeof(event_file)];
+	int fd;
+	FILE *logfile;
+	event_node_t *elp = event;
+	
+	if(strlen(event_spool_dir)){
+		
+		/* Make a template */
+		
+		strcpy(workstring, event_spool_dir);
+		strcat(workstring, event_file);
+		
+		/* Make the temporary file */
+		
+		fd = mkstemp(workstring);
+		
+		if(fd == -1){
+			ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: can't make temporary file\n");	
+			ast_log(LOG_DEBUG,"AlarmReceiver: can't make temporary file\n");
+			res = -1;
+		}
+		
+		if(!res){
+			logfile = fdopen(fd, "w");
+			if(logfile){
+				/* Write the file */
+				res = write_metadata(logfile, signalling_type, chan);
+				if(!res)
+					while((!res) && (elp != NULL)){
+						res = write_event(logfile, elp);
+						elp = elp->next;
+					}
+				if(!res){
+					if(fflush(logfile) == EOF)
+						res = -1;
+					if(!res){
+						if(fclose(logfile) == EOF)
+							res = -1;
+					}				
+				}
+			}
+			else
+				res = -1;
+		}
+	}
+
+	return res;	
+}
+
+/*
+* This function implements the logic to receive the Ademco contact ID  format.
+*
+* The function will return 0 when the caller hangs up, else a -1 if there was a problem.
+*/
+
+static int receive_ademco_contact_id( struct ast_channel *chan, void *data, int fdto, int sdto, int tldn, event_node_t **ehead)
+{
+	int i,j;
+	int res = 0;
+	int checksum;
+	char event[17];
+	event_node_t *enew, *elp;
+	int got_some_digits = 0;
+	int events_received = 0;
+	int ack_retries = 0;
+	
+	static char digit_map[15] = "0123456789*#ABC";
+        static unsigned char digit_weights[15] = {10,1,2,3,4,5,6,7,8,9,11,12,13,14,15};
+                                                                                                                      
+	database_increment("calls-received");
+
+	/* Wait for first event */
+
+	if(option_verbose >= 4)
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Waiting for first event from panel\n");
+
+	while(res >= 0){
+
+		if(got_some_digits == 0){
+
+	        	/* Send ACK tone sequence */
+                        
+		                                                                                                                    
+        		if(option_verbose >= 4)
+                		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Sending 1400Hz 100ms burst (ACK)\n");
+                                                                                                                                            
+                                                                                                                                            
+        		res = send_tone_burst(chan, 1400.0, 100, tldn);
+                                                                                                                                            
+        		if(!res)
+                		res = ast_safe_sleep(chan, 100);
+                                                                                                                                            
+        		if(!res){
+                		if(option_verbose >= 4)
+                        		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Sending 2300Hz 100ms burst (ACK)\n");
+                                                                                                                                            
+                		res = send_tone_burst(chan, 2300.0, 100, tldn);
+        		}
+                                                                                                                                            
+		}
+
+		if( res >= 0)
+			res = receive_dtmf_digits(chan, event, sizeof(event) - 1, fdto, sdto);
+		
+		if (res < 0){
+		
+			if(events_received == 0)
+				/* Hangup with no events received should be logged in the DB */
+				database_increment("no-events-received");
+			else{
+				if(ack_retries){
+					if(option_verbose >= 4)
+						ast_verbose(VERBOSE_PREFIX_2 "AlarmReceiver: ACK retries during this call: %d\n", ack_retries);
+					
+					database_increment("ack-retries");
+				}
+			}
+			if(option_verbose >= 4)
+				ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: App exiting...\n");
+			res = -1;
+			break;
+		}
+		
+		if(res != 0){
+			 /* Didn't get all of the digits */
+			if(option_verbose >= 2)
+				ast_verbose(VERBOSE_PREFIX_2 "AlarmReceiver: Incomplete string: %s, trying again...\n", event);
+
+			if(!got_some_digits){
+				got_some_digits = (strlen(event)) ? 1 : 0;
+				ack_retries++;
+			}
+			continue;	
+		}		
+		
+		got_some_digits = 1;
+
+		if(option_verbose >= 2)
+			ast_verbose(VERBOSE_PREFIX_2 "AlarmReceiver: Received Event %s\n", event);
+		ast_log(LOG_DEBUG, "AlarmReceiver: Received event: %s\n", event);
+		
+		/* Calculate checksum */
+		
+		for(j = 0, checksum = 0; j < 16; j++){
+			for(i = 0 ; i < sizeof(digit_map) ; i++){
+				if(digit_map[i] == event[j])
+					break;
+			}
+			
+			if(i == 16)
+				break;
+				
+			checksum += digit_weights[i];
+		}
+		
+		if(i == 16){
+			if(option_verbose >= 2)
+				ast_verbose(VERBOSE_PREFIX_2 "AlarmReceiver: Bad DTMF character %c, trying again\n", event[j]);
+			continue; /* Bad character */
+		}
+
+		/* Checksum is mod(15) of the total */
+
+		checksum = checksum % 15;
+
+		if(checksum){
+			database_increment("checksum-errors");
+			if(option_verbose >= 2){
+				ast_verbose(VERBOSE_PREFIX_2 "AlarmReceiver: Nonzero checksum\n");
+			ast_log(LOG_DEBUG, "AlarmReceiver: Nonzero checksum\n");
+			continue;
+			}
+		}
+
+		/* Check the message type for correctness */
+
+		if(strncmp(event + 4, "18", 2)){
+			if(strncmp(event + 4, "98", 2)){
+				database_increment("format-errors");
+				if(option_verbose >= 2)
+					ast_verbose(VERBOSE_PREFIX_2 "AlarmReceiver: Wrong message type\n");
+				ast_log(LOG_DEBUG, "AlarmReceiver: Wrong message type\n");
+			continue;
+			}
+		}
+
+		events_received++;
+		
+		/* Queue the Event */
+
+		if((enew = malloc(sizeof(event_node_t))) == NULL){
+			if(option_verbose >= 1)
+				ast_verbose(VERBOSE_PREFIX_1 "AlarmReceiver: Failed to allocate memory\n");
+			ast_log(LOG_WARNING, "AlarmReceiver Failed to allocate memory\n");
+			res = -1;
+                        break;
+		}
+		
+		enew->next = NULL;
+		strncpy(enew->data, event, sizeof(enew->data));
+
+		/*
+		* Insert event onto end of list
+		*/
+		
+		if(*ehead == NULL){
+			*ehead = enew;
+		}
+		else{
+			for(elp = *ehead; elp->next != NULL; elp = elp->next)
+			;
+			
+			elp->next = enew;
+		}
+		
+		if(res > 0)
+			res = 0;
+		
+		/* Let the user have the option of logging the single event before sending the kissoff tone */
+
+		if((res == 0) && (log_individual_events))
+			res = log_events(chan, ADEMCO_CONTACT_ID, enew);
+	
+		/* Wait 200 msec before sending kissoff */	
+			
+		if(res == 0)	
+			res = ast_safe_sleep(chan, 200);
+
+		/* Send the kissoff tone */
+
+		if(res == 0)		
+			res = send_tone_burst(chan, 1400.0, 900, tldn);
+	}
+
+	
+	return res;
+}
+
+
+/*
+* This is the main function called by Asterisk Core whenever the App is invoked in the extension logic.
+* This function will always return 0.
+*/
+
+static int alarmreceiver_exec(struct ast_channel *chan, void *data)
+{
+	int res = 0;
+	struct localuser *u;
+	event_node_t *elp, *efree;
+	char signalling_type[64];
+
+	event_node_t *event_head = NULL;
+
+	LOCAL_USER_ADD(u);
+
+	/* Set write and read formats to ULAW */
+
+	if(option_verbose >= 4)
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Setting read and write formats to ULAW\n");
+
+	if (ast_set_write_format(chan,AST_FORMAT_ULAW)){
+		ast_log(LOG_WARNING, "AlarmReceiver: Unable to set write format to Mu-law on %s\n",chan->name);
+		return -1;
+	}
+	
+	if (ast_set_read_format(chan,AST_FORMAT_ULAW)){
+		ast_log(LOG_WARNING, "AlarmReceiver: Unable to set read format to Mu-law on %s\n",chan->name);
+		return -1;
+	}
+
+	/* Set default values for this invokation of the application */
+	
+	strcpy(signalling_type, ADEMCO_CONTACT_ID);
+
+
+	/* Answer the channel if it is not already */
+
+	if(option_verbose >= 4)
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Answering channel\n");
+
+	if (chan->_state != AST_STATE_UP) {
+	
+		res = ast_answer(chan);
+		
+		if (res) {
+			LOCAL_USER_REMOVE(u);
+			return -1;
+		}
+	}
+
+	/* Wait for the connection to settle post-answer */
+
+	if(option_verbose >= 4)
+		ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: Waiting for connection to stabilize\n");
+
+	res = ast_safe_sleep(chan, 1250);
+
+	/* Attempt to receive the events */
+
+	if(!res){
+	
+		/* Determine the protocol to receive in advance */
+		/* Note: Ademco contact is the only one supported at this time */
+		/* Others may be added later */
+		
+		if(!strcmp(signalling_type, ADEMCO_CONTACT_ID))
+			receive_ademco_contact_id(chan, data, fdtimeout, sdtimeout, toneloudness, &event_head);
+		else
+			res = -1;
+	}
+	
+		
+	
+	/* Events queued by receiver, write them all out here if so configured */
+
+	if((!res) && (log_individual_events == 0)){
+		res = log_events(chan, signalling_type, event_head);
+
+	}
+
+	/*
+	* Do we exec a command line at the end?
+	*/
+	
+	if((!res) && (strlen(event_app)) && (event_head)){
+		ast_log(LOG_DEBUG,"Alarmreceiver: executing: %s\n", event_app);
+		ast_safe_system(event_app);
+	}
+
+	/*
+	* Free up the data allocated in our linked list
+	*/
+		
+	for(elp = event_head; (elp != NULL);){
+		efree = elp;
+		elp = elp->next;
+		free(efree);
+	}
+
+
+	LOCAL_USER_REMOVE(u);
+
+	return 0;
+}
+
+/* 
+* Load the configuration from the configuration file
+*/
+
+static int load_config(void)
+{
+	struct ast_config *cfg;
+	char *p;
+
+	/* Read in the config file */
+
+	cfg = ast_load(ALMRCV_CONFIG);
+                                                                                                                                  
+	if(!cfg){
+	
+		if(option_verbose >= 4)
+			ast_verbose(VERBOSE_PREFIX_4 "AlarmReceiver: No config file\n");
+	}
+	else{
+
+		
+		p = ast_variable_retrieve(cfg, "general", "eventcmd");
+		
+		if(p){
+			strncpy(event_app, p, sizeof(event_app) - 1);
+			event_app[sizeof(event_app) - 1] = '\0';
+		}
+		
+		p = ast_variable_retrieve(cfg, "general", "loudness");
+		if(p){
+			toneloudness = atoi(p);
+			if(toneloudness < 100)
+				toneloudness = 100;
+			if(toneloudness > 8192)
+				toneloudness = 8192;
+		}
+		p = ast_variable_retrieve(cfg, "general", "fdtimeout");
+		if(p){
+			fdtimeout = atoi(p);
+			if(fdtimeout < 1000)
+				fdtimeout = 1000;
+			if(fdtimeout > 10000)
+				fdtimeout = 10000;	
+		}
+		
+		p = ast_variable_retrieve(cfg, "general", "sdtimeout");
+		if(p){
+			sdtimeout = atoi(p);
+			if(sdtimeout < 110)
+				sdtimeout = 110;
+			if(sdtimeout > 4000)
+				sdtimeout = 4000;			
+
+		}
+		
+		p = ast_variable_retrieve(cfg, "general", "logindividualevents");
+		if(p){
+			log_individual_events = ast_true(p);
+
+		}
+		
+		p = ast_variable_retrieve(cfg, "general", "eventspooldir");
+			
+		if(p){
+			strncpy(event_spool_dir, p, sizeof(event_spool_dir) - 1);
+			event_spool_dir[sizeof(event_spool_dir) - 1] = '\0';
+		}
+		
+		p = ast_variable_retrieve(cfg, "general", "timestampformat");
+			
+		if(p){
+			strncpy(time_stamp_format, p, sizeof(time_stamp_format) - 1);
+			time_stamp_format[sizeof(time_stamp_format) - 1] = '\0';
+		}
+
+		p = ast_variable_retrieve(cfg, "general", "db-family");
+                                                                                                                                            
+		if(p){
+			strncpy(db_family, p, sizeof(db_family) - 1);
+			db_family[sizeof(db_family) - 1] = '\0';
+		}
+
+	}
+	return 0;
+
+}
+
+/*
+* These functions are required to implement an Asterisk App.
+*/
+
+
+int unload_module(void)
+{
+	STANDARD_HANGUP_LOCALUSERS;
+	return ast_unregister_application(app);
+}
+
+int load_module(void)
+{
+	load_config();
+	return ast_register_application(app, alarmreceiver_exec, synopsis, descrip);
+}
+
+char *description(void)
+{
+	return tdesc;
+}
+
+int usecount(void)
+{
+	int res;
+	STANDARD_USECOUNT(res);
+	return res;
+}
+
+char *key()
+{
+	return ASTERISK_GPL_KEY;
+}
diff --git a/configs/alarmreceiver.conf.sample b/configs/alarmreceiver.conf.sample
new file mode 100755
index 000000000..0c97a86ef
--- /dev/null
+++ b/configs/alarmreceiver.conf.sample
@@ -0,0 +1,76 @@
+;
+; alarmreceiver.conf
+;
+; Sample configuration file for the Asterisk alarm receiver application.
+;
+
+
+[general]
+
+;                                                                                                                                   
+; Specify a timestamp format for the metadata section of the event files
+; Default is %a %b %d, %Y @ %H:%M:%S %Z
+	        
+timestampformat = %a %b %d, %Y @ %H:%M:%S %Z
+
+;
+; Specify a command to execute when the caller hangs up
+;
+; Default is none
+;
+
+;eventcmd = yourprogram -yourargs ...
+
+;
+; Specify a spool directory for the event files. This setting is required if you want the app to be useful.
+; Event files written to the spool directory will be of the template event-XXXXXX, where XXXXXX is a random
+; and unique alphanumeric string.
+;
+; Default is none, and the events will be dropped on the floor.
+;
+
+eventspooldir = /tmp
+
+; 
+; The alarmreceiver app can either log the events one-at-a-time to individual files in the spool 
+; directory, or it can store them until the caller disconnects and write them all to one file.
+;
+; The default setting for logindividualevents is no.
+;
+
+logindividualevents = no
+
+;
+; The timeout for receiving the first DTMF digit is adjustable from  1000 msec. to 10000 msec. The
+; default is 2000 msec. Note: if you wish to test the receiver by entering digits manually, set this
+; to a reasonable time out like 10000 milliseconds. 
+
+fdtimeout = 2000
+
+;
+; The timeout for receiving subsequent DTMF digits is adjustable from  110 msec. to 4000 msec. The
+; default is 200 msec. Note: if you wish to test the receiver by entering digits manually, set this
+; to a reasonable time out like 4000 milliseconds. 
+;
+
+sdtimeout = 200
+
+;
+; The loudness of the ACK and Kissoff tones is adjustable from 100 to 8192. The default is 8192
+; This shouldn't need to be messed with, but is included just in case there are problems with 
+; signal levels.
+;
+
+loudness = 8192
+
+;
+; The db-family setting allows the user to capture statistics on the number of calls, and the errors
+; the alarm receiver sees. The default is for no db-family name to be defined and the database logging
+; to be turned off.
+;
+
+;db-family = yourfamily:
+
+;
+; End of alarmreceiver.conf
+;