$Id: README,v 1.4 2004/03/07 04:49:34 bsd Exp $

Magnevation SpeakJet Speech and Sound Sythesizer Module

This directory contains a complete test program for demonstrating the
use of the Magnevation SpeakJet speach chip with the BDMICRO MAVRIC
and MAVRIC-II microcontroller boards.  Feel free to copy the relevent
function definitions into your own applications and to customize them
for your needs.

This program is interactive and can be used with a terminal emulator
to issue control commands and play sequences of phonemes via a
command line interface.  Thanks to the large FLASH memory of the
ATmega128 on the MAVRIC / MAVRIC-II boards, the SpeakJet's full
phoneme table with codes, mnuemonics, and even text descriptions for
each of them is stored internally and can be displayed for easy
reference using the 'list' and 'listv' commands.

The code is written in C using the GNU GCC C Compiler.  A Makefile is
provided which is known to work correctly on the FreeBSD Unix
operating system.

Configuration:
 
  Hook up the SpeakJet according to its data sheet.  Attach the
  SpeakJet output to an amplifier.  Attach your MAVRIC or MAVRIC-II
  PORTD3 to SpeakJet pin 11 (Serial TTL Data).  It is important to use
  PORTD3 and not the MAVRIC/MAVRIC-II UART1 TX pin because the UART1
  TX pin is a level shifted RS232 voltage, while the SpeakJet utilizes
  just the TTL level.  PORTD3 on the MAVRIC/MAVRIC-II is the TTL level
  RS232 output pin which is the one to use with the SpeakJet.

  Next, hook up a serial terminal program to the UART0 of your MAVRIC
  / MAVRIC-II board.  A simple command line program is running on the
  MAVRIC which allows you to issue sequences of phoneme codes to the
  SpeakJet in order to experiment with putting together words,
  phrases, and sound effects.

  When the MAVRIC/MAVRIC-II comes out of reset, it will speak the
  phrase: "Welcome to the BDMICRO MAVRIC SpeakJet Test Program".  It
  then displays a brief help message and finally issues a '>>>' prompt
  on UART0 which indicates that is is ready to accept input for
  interacting with the SpeakJet.

  At the command prompt, you can enter phonemes and phoneme-codes
  which are then handed off to the SpeakJet to play.  For example, to
  say "ready", try the following:

    >>> rr eh de iy

  Use the 'list' command to list out all phoneme codes.  Use the
  'listv' command to get a verbose listing which includes not only the
  phonemes and codes, but also a brief description of each.

  Next, try a few sound effects using the 'B' series of mneumonics:

    >>> b4

  String multiple sound effects and phonemes together like this:

    >>> b4 b7 b7 b7 b8 b8

  If you prefer to use the raw codes, simply list the numeric
  equivalents of the phoneme mnuemonics:

    >>> 224 227 227 227 228 228

  Phoneme mneumonics and codes should be seperated by a space or a
  comma.  A leading backslash is also acceptable, and they are not
  case sensitive.

  Use the '?' command to print a brief help message.  The startup
  announcement message can be played by using the 'announce' command.

For more information about the MAVRIC and MAVRIC-II microcontroller
boards, see:

  http://www.bdmicro.com/

For more information about the Magnevation SpeakJet Speech chip, see:

  http://www.speakjet.com/