some more python work

git-svn-id: file:///home/lennart/svn/public/ivam2/trunk@22 dbf6933d-3bce-0310-9bcc-ed052ba35b35

2 files changed, 86 insertions, 0 deletions

diff --git a/doc/README.VoiceBox b/doc/README.VoiceBox
new file mode 100644
index 0000000..885742a
--- /dev/null
+++ b/doc/README.VoiceBox
@@ -0,0 +1,84 @@
+In the voice box spool directory the following files may be used to
+adjust configuration options:
+
+./RECORD_TIME
+        
+        Specify the time in seconds when message recording is stopped.
+
+        Defaults to "60".
+
+./PIN
+
+        Specify the PIN for the voice box when queried over the phone
+        line. This should be a string capable of being entered via DTMF
+        tones, thus consisting of 0-9, *, # only. The length is up to you.
+
+        Two special PINs may be set: an empty string disables all
+        authentication, "-" will deny all authentication attempts.
+
+        Defaults to "-".
+
+./newmessage
+
+        This should be a link pointing to a script which is called
+        whenever a new message is recorded. It is run with a single
+        argument: the filename of the recorded message. Special
+        environment variables are passed:
+
+                    RINGMSN
+
+                        The local number of the voice box
+
+                    CALLERMSN
+                    
+                        The remote number the message originates from
+
+                    LENGTH
+
+                        The length in bytes of the uncompressed voice
+                        message. Since the sampling rate of the ISDN
+                        is fixed to 8000Hz divide this value by 8000
+                        to get the length in seconds.
+
+                    SEC_LENGTH
+
+                        The length in seconds of the voice message
+                        written as fixed point number. This is the
+                        same as LENGTH/8000.
+
+                    SPOOLDIR
+
+                        The spool directory where the configuration of
+                        the voice box resides.
+
+./EMAIL
+
+       Specify the email address of the owner of this voice box. This
+       address ist notified whenever a new message is recorded. It is
+       interpreted by the default newmessage script. If you change
+       that script this file may become useless.
+
+       Defaults to "root".
+
+./*.ulaw.gz
+
+        These are audio files which are used by the voice box
+        automaton. You may replace them with your on recordings.
+
+        ./welcome.ulaw.gz           -- The welcome message
+        ./authok.ulaw.gz            -- "Authentication successful"
+        ./beep.ulaw.gz              -- A beep
+        ./nomoremessages.ulaw.gz    -- "No more messages available"
+        ./auth.ulaw.gz              -- "Please authenticate"
+        ./empty.ulaw.gz             -- "The voice box is empty"
+        ./removed.ulaw.gz           -- "Message deleted successfully"
+
+./messages/
+
+        This is not a configuration item but where the recorded
+        messages are stored. You are free to delete any message from
+        the voice box by issuing standard Unix commands like 'rm'
+        inside this directory. The file names inside the directory
+        include the Unix time, the local number and the originating
+        number seperated by colons.
+
diff --git a/doc/TODO b/doc/TODO
index 78fc329..97e6c8f 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -6,7 +6,9 @@
 * @same support
 * uid switching for each client
 * init script
+* mail on successful mailbox creation in ivam-autobox
 
+* --no-record --record-only (for voicebox) (DONE)
 * make it a daemon (DONE)
 * newmessage script (DONE)
 * python part (DONE)