aparry3 / safeword

Voice activated assistance application

SafeWord Release Notes & Install Guide

The application allows users to set custom words to have specific functions. These functions can range from texting a friend, sending a location, or calling authorities, though not all are fully implemented yet. SafeWord provides a user-friendly interface that allows users to add words and decide which tasks are associated with that word. Once a customized word is said aloud while the application is activated, the application will execute the word’s tasks.

SafeWord Version 1.0 Release Notes

These notes will provide an overview of SafeWord's (v1.0) primary features and how to install it onto an iPhone device.

New Software Features (v1.0 12/04/2017)

-Add words that have location text triggers by toggling "Send Location" on a created word
-Add contacts to text by adding a contact and selecting the words to trigger that contact on
-Activate and deactive the application, allowing users to decide when words will be triggered
-Say trigger words during activated state to trigger the contacts that the user has set

Bug Fixes Made Since Last Release (v0.5)

-Contacts added to words will now be contacted instead of a hard-coded contact
-Activation can now be turned on and off indefinitely

Known Bugs & Defects

-Currently only supports texting contacts a predetermined location
-Record audio and delay toggles are placeholders
-Only contacts mapped on the Contact page to words will be triggered, though a mapping to contacts is provided for words
-Must deactivate app for triggers to commence

SafeWord Install Guide

SafeWord is built on Ionic 2, allowing one to deploy on Android and iPhone. However, the code is currently written to be optimized for iOS, so this guide will be geared towards iPhone installation and execution.

Pre-requisites

XCode Version 9.1
iPhone running iOS 10 or later

Dependent libraries that must be installed

Node.js
Cordova
Ionic 2

Download instructions

The project can be directly cloned or downloaded from the SafeWord github: https://github.com/aparry3/SafeWord

Build instructions

-Make sure to have XCode and dependencies installed
-Download SafeWord project from the Github
-Navigate to the top level of the project in your terminal
run:
ionic cordova build ios --prod

to build the project. You may have to run the following if the iOS platform is missing:

ionic cordova platform add ios

Installation of actual application

Once the project is built, open it within XCode by navigating to SafeWord/platforms/ios/MyApp.xcodeproj

Plug in your iPhone device. In XCode, select the target device for MyApp to be your device. Then, under Product, in XCode's toolbar, select Run. An error will appear saying that the app needs proper permissions on your device to run. On your iPhone, navigate to Settings, then General, and then Device Management. This is where you can allow your device to accept the app to run. After saying you trust this developer, hit run again and the application will deploy and automatically open.

Run instructions:

The app will now run on your phone like any other iPhone application. Serious bugs may require redeployment by deleting and repeating the steps above.

Troubleshooting:

If you run into problems downloading and running the solution the following may help:

• Older versions of XCode will not work with the latest iOS, and visa versa. Make sure to have both fully updated
• Redeploy the application by deleting and redownloading the SafeWord directory (Configuration files could have been tampered by running otherionic cordova commands)
• Check your computer's applications to be sure the necessary pre-requisites described above are installed
• Try turning your computer off and then on again (This will ensure that any restart dependent installations have occured)

safeword's Issues

Improve UI of Entire Application

As a user, I want to turn off SafeWord so I can no longer trigger the application.

Story entails creating the main activity button on the home page, if not already created. When pressed, the button should say "Inactive" and the home page color should be red.

Setup Emulation on iOS or Android for each member

Each member of the team should be able to emulate SafeWord on either iOS or Android

As a user, I want to create a safe word so I can view the safe word on my words page.

Story entails possibly creating a create safe word page where the user can enter in a safe word, which will, after submission, add a new entry to the words page.

Meeting Minutes: Week of 10/2

Detailed Design 1st Draft

Improving Home Page

Create Presentation Semester Overview/Slides

As a user, I want to edit my profile page so I can have a more personalized experience.

Story entails creating the initial profile page for safe word. The initial profile page will include editable attributes that describe the user such as name and email address.

Create the Edit Word Page

"Edit Word Page" creation

Action Items:

• create page UI
• When a word is updated, be sure it is updated on both the Words Page and in the words array which will be used for voice recognition purposes.

Visual Example:
Note: not all buttons need to be implemented or created

Implement Initial Voice Recognition

Research into and implement initial voice recognition features for the "Activation Page". When a word is recognized, the application should display something like, "(Insert word here) has been detected".

Integrate created words with contacts

Words Page Creation

Epic entails creating the initial words page of SafeWord, supplying features to create, edit, and delete a safe word.

Meeting Minutes for 10/25/17

As a user, I want to navigate to the profile page from the home page so I can see my profile.

Story entails creating a button on the home page that, when pressed, takes the user to the profile page.

Update the Words Page

Update the "Words Page"

Action Items:

• Add an addition button to go to the "Create Word Page"
• When clicked, a safe word in the list should go to the "Edit Word Page"
• The word list should start off empty. Note that, when new words are added, they should be added to an array (for voice recognition purposes).

Visual Example:

Remove Settings Page

Improve layout of Profile Page

Improve the css and functionality of the profile page

Remove Settings Page

Create Sprint 1 Memo: Due 9/15

Create and submit the memo for sprint 1. Follow the rubric and guidelines specified in the retrospective assignment rubric. The memo is due Friday, 9/15 by 11:59 pm.

Implement Voice Functionality in Android

Words Page Refactor

Refactor the words page to have it look and function more like our moqups prototype.

Words Page:

Create Word Page:

Edit Word Page:

[Duplicate Issue] Improve Contact Page Functionality/Appearance

Research Voice Recognition Libraries

Research into and choose a voice recognition library to implement the voice aspects of SafeWord.

Detailed Design Final Draft

Started on functionalities for contacts page for Sprint 3 ~ carried over from Sprint 2

As a user, I want to delete a safe word so I can no longer view the safe word on my words page.

Story entails creating the ability to delete a safe word from the words list.

Create a Settings Page

Meeting Minutes: Week of 9/10

Create meeting minutes for the week of 9/10.

Create the Create Word Page

"Create Word Page" creation

Action Items:

• Create UI for page
• upon word creation, add it to some sort of array (for voice recognition purposes)

Visual Example:
Note: not all buttons in the image are necessary

Fix Home Page Bug

The home page currently calls different screens when the main action button is pressed causing a stack of screens to be created. Update the home page to be only one page where only the css is changed when the main action button is pressed.

Sprint 4 Demo

As a user, I want to turn on SafeWord so that I can activate the application.

Story entails creating the main activity button on the home page, if not already created. When pressed, the button should say "Listening" and the home page color should be green.

Peer Code Review

Meeting Minutes 9/6/17

Create and submit meeting minutes for meeting held on 9/6/17

Video Demo 1

Create and submit a video by 9/10/17 demonstrating the features completed in sprint 1

Meeting Minutes: Week of 9/17

Implement Texting Functionality

Detailed Design Document

Sprint 2 Memo

Create a memo based off of the sprint 2 retrospective. Be sure to look at the gradesheets for the first memo to ensure we do not make the same mistakes. The memo should also discuss how effective our sprint 1 memo action plan was.

Create Presentation Introduction/Slides

Detailed Design 2nd Draft

As a user, I want to edit an existing safe word so I can change the safe word to a different word.

Story entails possibly creating an edit safe word page where the user can edit in an existing safe word, which will, after submission, update that safe words entry on the words page.

Client Meeting 9/13

Prepare a presentation for and attend client meeting with Melinda McDaniel on Wednesday 9/13

create contacts_enhancements branch and fix utility/functionality/design of contacts page

Video Demo 2

Create the video demo for sprint 2.

Home Page Creation

Epic entails creating the initial home page for SafeWord, supplying features for activation and page navigation to the words page and profile page of the app.

Watch Angular 2 Videos

As a user, I want to navigate to the words page from the home page so I can see my existing words.

Story entails creating a button on the home page that, when pressed, takes the user to the words page.

As a user, I want to say one of my words to SafeWord while it is active so I can trigger the application.

Action Items:

• Use the library suggested in #22
• If necessary have some sort of global boolean to tell whether SafeWord is listening or not
• When a safe word in the "Words Page" is detected and SafeWord is listening, have a pop-up that states that "(Insert Word Here) was detected"