Differences

This shows you the differences between two versions of the page.

--- proj [2018/12/19 19:21] – bil
+++ proj [2019/03/06 15:28] (current) – bil
@@ Line 1: / Line 1: @@
-**EECS 2311 Project**
+====== EECS 2311 Project ======
-<html><!--
+====== New requirements added on March 6! See below... ======
-  To be posted.
+TalkBox is a device that helps anybody, who is unable to talk, communicate.
+Each TalkBox has a number of buttons that the user can press to play pre-recorded audio files.
+Some of the buttons on the TalkBox may be used to load different sets of audio files.
+{{:talkbox.jpeg|TalkBox}}
+We will develop two pieces of software to help family members configure a TalkBox device with audio appropriate for their situation.
+**1. TalkBox Simulator**
-Treasure Box Braille (TBB) is a device that helps kids learn how to read Braille.
+A piece of software that simulates the behaviour of any TalkBox device.
-TBB presents Braille characters/words to the user who then responds by pressing buttons.
-Educators can load different scenarios to teach different letters and keep the kids entertained.
-We will write a piece of software to help educators create these scenarios. We will call it the Authoring App. The Authoring app will provide facilities to
+Has a user interface similar to that of the device.
-  * Create the flow of the scenario (ask questions, receive answers)
-  * Record audio
-  * Save the scenario in the appropriate format
-  * Test the scenario using the provided software
-**Important requirement**: The Authoring App must be usable by visually-impaired users
+The number of buttons and their functionality is configurable.
-Since there are not enough TBBs for each group (and also because they are expensive and hard to replace), we provide software that simulates the TBB.
+Is fully tested to behave as the hardware device.
-This way, as an educator is preparing a scenario with your authoring app, they can try it out to see if it works. See the Week 1 slides (click on Course Outline) for instructions on how to get the starter software.
-The starter software contains example scenarios that you can run to get a feel for what this system does.
+**2. TalkBox Configuration app**
-{{:startersoftwaredesign.pdf|Click here}} for a UML diagram of the starter software.
+A user-friendly GUI-based app that allows for the configuration of a TalkBox device with appropriate audio.
-{{:scenarioformat.pdf|Click here}} for a description of the file format for scenarios.
+It will provide facilities to record audio, or select already pre-recorded audio files.
-**New requirement (added on Feb 27, 2018)**
+It will allow the user to associate audio files with buttons in an intuitive way.
-Your system must log all actions the user takes and keep count of how many times each feature is accessed
+It will store the configuration in a USB flash drive to be used with an actual TalkBox, or will launch the Talkbox Simulator to test.
-Based on the log data, add keyboard shortcuts to the most frequently used features. Such features should be easy to access with a mouse as well
+The TalkBox Configuration app and the TalkBox simulator will communicate through the use of a TalkBoxConfiguration object that will be serialized
+**Important Requirement**: Your code must serialize and deserialize an object that implements the [[http://www.eecs.yorku.ca/~bil/2311/TalkBoxConfiguration.java|TalkBoxConfiguration]] interface.
+The TalkBox Configuration app must create a directory called TalkBoxData that contains the serialized object (extension must be .tbc) and the audio files. It can then launch the TalkBox Simulator and provide the path to the TalkBoxData directory as a runtime argument.
+**New requirements added on March 6**
+**New Simulator requirement**: If the user presses a button while an audio is playing, that audio stops before the audio corresponding to the button starts
+You may have to look into naming, searching for, and stopping threads
+**Second new requirement**: Your system must log all actions the user takes in both apps
+What buttons they press, what menu options they select etc.
+The Configuration app must have a way to visualize the Simulator logs
+This will allow the caretaker to optimize the configuration
+You must also create **a third app**, called TBCLog, that visualizes the Configuration app logs
+The purpose of this app is for the research team to determine how users use the Configuration app
+<html><!--
+  To be posted.
 --></html>