Differences

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

--- proj [2017/02/08 16:19] – bil
+++ proj [2019/03/06 15:28] (current) – bil
@@ Line 1: / Line 1: @@
-**EECS 2311 Project**
+====== EECS 2311 Project ======
-This term's project is to develop software for a hardware device used to help kids read Braille.
+====== New requirements added on March 6! See below... ======
-The hardware device will have a number of Braille cells, as well as a number of physical buttons.
-The system presents Braille characters/words to the user who then responds by pressing buttons.
+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.
-You can get a sample usage scenario for the system {{:adventure_on_the_high_seas.pdf|here}}.
+{{:talkbox.jpeg|TalkBox}}
+We will develop two pieces of software to help family members configure a TalkBox device with audio appropriate for their situation.
-The hardware will be under development this term as well, so our first task will be to develop a...
+**1. TalkBox Simulator**
-**Simulator**
+A piece of software that simulates the behaviour of any TalkBox device.
-A piece of software that simulates the behaviour of the hardware device
+Has a user interface similar to that of the device.
-Has a user interface similar to that of the device
+The number of buttons and their functionality is configurable.
-Is fully tested to behave as the hardware device
+Is fully tested to behave as the hardware device.
-Presents an API that the rest of the system will use to communicate with it
+**2. TalkBox Configuration app**
-**Simulator API**
+A user-friendly GUI-based app that allows for the configuration of a TalkBox device with appropriate audio.
-The most critical part of the Simulator is the API it will present to the Player and Authoring app
+It will provide facilities to record audio, or select already pre-recorded audio files.
-This API must be able to be duplicated by the hardware device (its firmware will include a firmware wrapper)
+It will allow the user to associate audio files with buttons in an intuitive way.
-API must be described in detail with Javadoc
+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.
-The best simulator API from all submissions will be chosen going forward
-**Simulator Submission Details**
+The TalkBox Configuration app and the TalkBox simulator will communicate through the use of a TalkBoxConfiguration object that will be serialized
-Rubric posted under Evaluation
+**Important Requirement**: Your code must serialize and deserialize an object that implements the [[http://www.eecs.yorku.ca/~bil/2311/TalkBoxConfiguration.java|TalkBoxConfiguration]] interface.
-Four grade components
-  - Requirements document
+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.
-  - Testing document
-  - Simulator API
-  - Implementation
-**Simulator Submission Process**
+**New requirements added on March 6**
-. Create a .zip or .jar that contains the following:
+**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
-  * All grade components from the previous slide including the code
+You may have to look into naming, searching for, and stopping threads
-  * A README.txt that
-    * Explains the contents of the zip file
-    * Describes how to access the API in HTML
-    * Provides a link to your github repository
-. Email the zip file to bil@cse.yorku.ca by 11:59pm on Feb 7
+**Second new requirement**: Your system must log all actions the user takes in both apps
-  * Only one email per team
-  * Include your team number in the subject
-. Each student must also send me a private email with an assessment of their teammates’ contributions
+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>