segfaultcity / zephyrgroup3

Zephyr project done by Group 3 of 4320.

ZephyrGroup3

Zephyr project done by Group 3 of 4320.

Home automation system the provides random reminders, alarms for schedules, and infant routine reminders. The system will benefit all parts of a household and provide an all in one reminder system available all throughout the stakeholders establishment.

Sprint 2 Installation and Configuration

Install Virtual Box if you have not already done so

Download the virtual appliace from here:
Download our Build

Import the virtual appliance by clicking file (In your VirtualBox desktop app) -> import appliance and navigate and select the .ova file you donloaded in the previos step

Boot Up the newly created virtual macine and login to the "User" account and use password "pass"

Navigate to Documents/zephyr in the terminal

Run the command
source ~/Documents/zephyr/zephyr/bin/activate

Now navigate to our project folder in the terminal inside the zephyr venv
cd ~/Documents/zephyr/zephyrproject/zephyr/Zephyr-Group-3/Project

Next, compile the project
make -f Makefile.posix

To run the project run the command
./clock

Link to our website: Remind O' Clock

Proof our system works:

Demo Video: https://youtu.be/v8tjwYbuZyU

Routine Creation:

Routine is inserted into our database:

Emulating the app GET request by our webservice:

Running the zephyr app and getting the same result:

Checkout the sprint2 doc:

Sprint2

Difficulties we ran into:

Sprint 2 Difficulties

zephyrgroup3's Issues

Create random reminders functionality (Web)

To-do:
This issue should be closed when random reminders is implemented on the server. A table should be added to the database and should be inserted into through user forms via the web service.

Create daily reminders functionality (Web)

Currently, Daily Reminders are not supported. This issue should be closed after Daily Reminders is fully functional on the server. This includes table creation and the ability to populate that table through user forms and insertions on the web service.

Encrypt user sign-up passwords before database insertion

Currently, passwords are vulnerable. This issue should be closed when the password is encrypted.

Change format from plain text to JSON on web service

Problem:
The web service the Zephyr app executes its GET request for returns plain text, which is hard to parse and in turn makes it hard to grab the time needed for the alarm.
Solution:
Change the returned data of the web service to JSON format so the zephyr app can parse it using C language.

Change Sound of alarm

Problem: Currently, the alarm makes a basic beeping sound.
Request: A way to make a more user friendly and pleasing alarm sound.

Grab daily reminders via HTTP (Zephyr App)

Problem:
Zephyr app does not currently implement the daily reminders use case.
Solution:
Refer to infant routine mode for the zephyr app and use that structure to create the daily reminders implementation.

This issue should be closed when the Zephyr application can successfully use GET request to grab alarm information from the web service and display it.

Error check reminder forms

Problem: Currently, fields can be left blank and be inserted into the database. This causes an issue when a user wants to receive the data later because they could be missing a key element for their reminder.
Solution: Create form alerts for when required fields are left empty and reject insertions.

Grab random reminders via HTTP (Zephyr App)

This issue should be closed when the Zephyr application can successfully grab and display user random reminder information on our web service using a GET request.

Missing formal Stubs Document

Needs a formal stubs document.

Make reminder forms on the web side more detailed

Upon user test, common feedback was that the forms on the web side needed to be more specific and detailed. As of now, the input boxes are simply text and should appropriately be changed to dropdown boxes and date pickers for needed fields.

Solution requires simple html and CSS, so this issue is marked as low priority.

Error Check if user Exists

On the server end send a response if the user selected exists.

Return more the one alarm for each reminder type

Currently, only one reminder is ever returned when requesting alarms via the zephyr app. Ex: Jimmy wants ALL his daily reminders displayed in the zephyr app, but even if Jimmy has more than one, the most recent is the only one returned.

Create a way to Access the different use cases on Zephyr

Solution: create a switch case that leads to the logic for each use case's logic.

Create a physical alarm when the time needed is struck

Problem:
Currently, the time needed for the alarm is retrieved by the app but no physical alarming is ever sounded.
Solution:
This will require a way to parse the retrieved data (May need to change data modeling on the web by having it return JSON when receiving GET request). Once parsed, C code should run with the clock library to sound an alarm at the needed time.

Create credential step when trying to access user information via Zephyr app

This issue should be closed when a users information is successfully protected via the zephyr app. For example, when a user try's to run a GET request for a username, they should be prompted for that usernames password in order to get its returned associated data. This issue will need work on both the Zephyr App and web service.