Skip to content

sabinach/braille-elearner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Braille E-Learner

6.835 Spring 2020 - Final Project

Project Description

Braille E-Learner is a tactile, auditory, and visual (optional) multimodal learning system that teaches users Braille through an interactive feedback system. This system enables users to learn Braille by themselves without the need for an actual instructor on the side.

Project Deliverables


Quick Setup (only run if all dependencies installed, hardware set-up, etc.)

To activate venv

  • source venv/bin/activate

To run script

  • cd src
  • python2.7 main.py

PERSONAL NOTE (everyone else can ignore):

  • Make sure your conda, python, and python3 aliases in ~/.bash_profile are commented out before you activate venv!

Folders

dev/

  • Test scripts used during development (reference code~ not guaranteed to work, not used in final implementation)

docs/

  • Miscellaneous documentation related to the project

img/

  • Images used for braille symbol generation

json/

  • Calibration and symbol generation settings

lib/

  • Leap motion SDK

src/

  • Working scripts used in the final implementation

File Descriptions

Top-level Script (src)

  • main.py - primary script that integrates all the separate modes together

Global calibration (src/modes)

  • calibrate_leap.py - set the finger minX/maxX boundaries
  • calibrate_camera.py - save cell/dot boundaries

User Modes (src/modes)

  • generate_dots.py - generate new symbol orders, guide users in setting up peg slate
  • learn.py - learn mode
  • review.py - review mode

Parameters and Helper functions (src)

  • params.py - parameters
  • utils.py - helper functions

System requirements

Hardware

Software

  • virtualenv venv -p python2.7
  • source venv/bin/activate
  • Install package requirements (specified below)

Package Requirements

PyPi Speech Recognition

  • pip install SpeechRecognition

Google Cloud Speech API

  • pip install google-api-python-client

Pygame

  • pip install pygame

Pocket Sphinx API

  • brew install swig git python
  • pip install pocketsphinx

OpenCV (Version 4.2.0)

  • pip install opencv-python
  • pip install opencv-contrib-python
  • pip install opencv-python-headless

Numpy

  • pip install numpy

Pathlib

  • pip install pathlib

osascript (AppleScript wrapper)

  • pip install osascript

Optional Packages (used for dev/test)

Monitor and control user input devices

  • pip install pynput

Process and system monitoring

  • pip install psutil

For faster operations

  • pip install monotonic

Text-to-speech

  • pip install pyttsx3

For microphone

  • brew install portaudio
  • pip install pyaudio

System Architecture

System Architecture


Example Usage

Example Usage


Hardware Setup

Hardware Setup

About

6.835 Intelligent Multimodal User Interfaces (Final Project) - Spring 2020

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages