project-pill-io created by GitHub Classroom
- Abin Cheriyan
- Anna Minasyan
- Ethan Lewis
- Misha Golikov
- Tandi Huran
This project proposes a machine learning empowered pill dispenser that will allow both caregivers and patients to have peace of mind as they partake in what for most of them is a daily requirement for their health and safety. This pill dispensing software will allow for medications to always be dispensed with only the needed medications and dosages based on the facial recognition of the patient attempting to get their medication. This will allow patients to get their medication without the struggle of opening or sorting through pill bottles and help prevent the possibility of an overdose on medications by no longer having patients access of all their medicine supply at the same time. Moreover, caregivers will be able to access data regarding the frequency and timing of when/if their patients take their medications which will help inform their care.
Install packages with pip: -r requirements.txt The following command will install the packages according to the configuration file requirements.txt.
$ pip install -r requirements.txt
https://pillio.pythonanywhere.com/
This is our first release, so there is no previous release to compare to. This release contains preliminary:
- Sign-Up/Registration functionality with crosschecking against existing accounts to prevent duplicate users, with password hashing and the ability to upload a user picture, where in the future, it is to be used as a profile picture and for crosschecking facial recognition.
- Login functionality with countermeasures to prevent against incorrectly formatted emails (such as no @ symbol), as well as the hashing of user passwords using the SHA256 encryption algorithm.
- Medication Management System where a user is able to select an arbitrary pill and select the time they wish to take it at (not yet connected to the database).
- Authentication Success/Failure/Loading Screens, where a user is able to stream their webcam on the website and take a photo of themselves, where it will be used for facial recognition in the future.
- NOT INCLUDED IN REPO: Facial Recognition algorithm and functionality on the Jetson Nano that allows a user to authenticate themselves by scanning their face in the camera, after which they are told how many times they've visited that camera in the past.
Instructions on how to use and test the release (contains instructions similar to the Test Procedures document).
!! MILESTONE DEMO 1 !!
Test 1: Creating an Account:
Actions/Steps:
- Click Sign Up on the navbar
- Enter Username (it has to be an email)
- Enter your first name
- Enter your last name
- Enter your preferred Password
- Enter your Date of Birth
- Enter a picture of your face (it will later be used as your Profile Picture and for facial recognition)
- Press the Sign Up Button at the bottom of the form
Expected Results:
- The user is able to Sign up without any problem and the system will save the user's details onto the db.
- User will see an "Account created" confirmation popup
Test 2: Logging into an Account:
Actions/Steps:
- Click Login on the navbar
- Enter your email in the field marked "Your Email"
- Enter your password in the field marked "Your Password", the password is case sensitive as usual
- Check the checkbox marked "Remember me" if you wish for the website/browser to save your cookies
and leave you logged into account when you visit the website again
- Press the Login Button at the bottom of the form
Expected Results:
- The user is able to login into their already existing account with no problems, where
- The user will see the "Medication Form" page in front of them, which is marked by the "/profile" page identifier in the URL
- If the user checked the "Remember me" checkbox, they are able to close the website, reopen it, and still be logged in.
- If the user did not check the "Remember me" checkbox, they will be required to login again when they close and reopen the website.
Test 3: Accessing help/faq page:
Actions/Steps:
- Click on Login on the navbar
- Enter your credentials
- Click on Login button
- Once logged in, Help page should be available to authenticated user on the navbar
- Click on the "Help" button on navbar
Expected Results:
- User should be able to access the help page and access the drop down menu with answers. The help icon in
the navbar will only appear if the user is logged in.
- User should not see the help bar if they arent logged in
Test 4: Logout:
Actions/Steps:
- Once the user login, go to the navbar on top of the page
- Click the logout button on top right
Expected Results:
- The user should be able to see the logout button when signed in. After the button is clicked, the website
should take the user to the homepage / login screen
Test 5: Using Webcam:
Actions/Steps:
- Click Sign Up
- Scroll to Webcam Access Page
- Click Start Webcam Button
- Click Take Snapshot
Expected Results:
- The user should be able to capture their face after turning on their webcam and clicking the take
snapshot button. (Use Google Chrome for best results)
!! MILESTONE DEMO 2 !!
What's Changed: - Merge Pi 119 implement user login data retrieval functionality into Main by @mishagolikov in #16 - Create userDash board without banner by @t-harun in #17 - Pi 136 update settings UI by @tuh00755 in #18 - Improved UI Look by @tuh00755 in #19 - Issue Collector by @tuh00755 in #21 - Added banner with button for scan by @t-harun in #22 - Pi 134 fix hello username issue in profile page by @t-harun in #23 - Merge 134 - Fixed corrupt DB file, now fully working into main by @mishagolikov in #24 - Add files via upload by @AnyaMin in #25 - Settings merge conflict Resolved by @Ethanterrel in #27 - Pi 139 implement medication schedule function in user dash board by @t-harun in #29 - Pi 140 reformat website navigation by @t-harun in #28 - Merge 141 - Medform and MedList into main by @mishagolikov in #30 - Merge Pi 141 add pill dispensing related fields to database and add fields to related forms into main branch by @mishagolikov in #32
Creating an Account:
Actions/Steps:
- Click Sign Up on the navbar
- Enter Username (it has to be an email)
- Enter your first name
- Enter your last name
- Enter your preferred Password
- Enter your Date of Birth
- Enter a picture of your face (THIS STEP IS REQUIRED & {'.jpg', '.png', '.gif'} FORMATS ONLY)
- Use different pictures since or the database will throw an error if the pic isnt unique
- it will later be used as your Profile Picture and for facial recognition
- Press the Sign Up Button at the bottom of the form
Expected Results:
- The user is able to Sign up without any problem and the system will save the user's details onto the db.
- User will see an "Account created" confirmation popup
Logging into an Account :
Actions/Steps:
- Click Login on the navbar
- Enter your email in the field marked "Your Email"
- Enter your password in the field marked "Your Password", the password is case sensitive as usual
- Check the checkbox marked "Remember me" if you wish for the website/browser to save your cookies
and leave you logged into account when you visit the website again
- Press the Login Button at the bottom of the form
Expected Results:
- The user is able to login into their already existing account with no problems, where
- The user will see the "Medication Form" page in front of them, which is marked by the "/profile" page identifier in the URL
- If the user checked the "Remember me" checkbox, they are able to close the website, reopen it, and still be logged in.
- If the user did not check the "Remember me" checkbox, they will be required to login again when they close and reopen the website.
Test 1: (Changing / Updating your DoB):
Actions/Steps:
- Login using your credentials
- Click on "Account" on the navbar up top
- Scroll down to the bottom to where it says "Change DoB"
- Enter your new DoB in the same format as it previously was
- Press Submit and you will see your updated DoB
Expected Results:
- Upon successfully changing DoB, the user should see his updated DoB on the settings page
Test 2: (Changing / Uploading Your email):
Actions/Steps:
- Login using your credentials
- Click on "Account" on the navbar up top
- Scroll down to the bottom to where it says "Change your email"
- Enter your new email
- Press Submit and you will see your updated email
Expected Results:
- Upon successfully changing the email, the user should see his or her updated email in the
settings page and the user will not be able to login back into that account with that credentials.
Test 3: (Changing / Uploading a new profile Pic):
Actions/Steps:
- Login using your credentials
- Click on "Account" on the navbar up top
- Scroll down to the bottom to where it says "Upload New PROFILE Photo"
- File format has to be one of these {'.jpg', '.png', '.gif'}. Anything else will throw an error
or crash the website
- Upload your new Picture
- Scroll up to the top of the page and youll see your updated/new picture
Expected Results:
- Upon successfully uploading the pic, the user should see his or her updated profile pic (240pxx240px)
in the settings page
Test 4: (Changing / Updating a new First/Last name):
Actions/Steps:
- Login using your credentials
- Click on "Account" on the navbar up top
- Scroll down to the bottom where it says change your First Name
- Scroll down to the bottom where it says change your Last Name
- Enter your new First Name and Last Name
- Press Submit and you will see your updated First and Last Name
Expected Results:
- Upon successfully submitting, the user should see his updated First and Last name assoicated with his account
Test 5: (Entering/Submitting a new Medication/Prescription):
Actions/Steps:
- Login using your credentials
- Click on "Medform" on the navbar up top
- Scroll down and click on the "+" button at the bottom of the form to add another form
- Fill out the required information for each medication form (two medications/two forms)
- For this release, each medication name and class must be unique and must not be
already existing duplicates
- Furthermore, the dosage field must be filled out in the format of "XXmg", instead of
"XX" or "XX mg", where XX is the number of milligrams of the medication.
- Once you're done filling out the form, click submit at the bottom of the form
Expected Results:
- Upon successfully submitting, the page will refresh and the form will clear, marking that
your medication has been successfully submitted
Test 6: (Viewing one's Medication list):
Actions/Steps:
- Login using your credentials
- Click on "Dashboard" on the navbar up top
- Scroll down and locate the "Medication List" containter; press the "Get Medication"
button to retrieve a list of your medications
- Look at your newly visible medication list and make sure it matches the ones entered
in Test 6
Expected Results:
- Upon successfully retrieving the list, one should see a table of their newly created
medications from Test 6, with Name, Type, Dose, and Time columns visible in the table
!! MILESTONE DEMO 3 !!
What's Changed Add Schedule function by @t-harun in #33 Fixed medication form entering multiple medications at once, no longe… by @t-harun in #34 Pi 156 save picture web cam locally by @Ethanterrel in #36 Added logo on navbar by @tuh00755 in #35 Pi 37 create text to speech audio receiver element by @tuh00755 in #37 jpg gif png by @tuh00755 in #38 Pi 162 create alerts notifications for all pages by @t-harun in #39 Merge Pi 163 fix issue medication form and medication list with tandi into main by @mishagolikov in #42 Merge Pi 164 create tests for medication form and medication list into Main by @mishagolikov in #40 Merge Pi 165 create database restrictions and error handling for user entry for medication form into main by @mishagolikov in #41 Pi 184 work on medform delete functionality with tandi by @t-harun in #43
Creating an Account:
Actions/Steps:
- Click Sign Up on the navbar
- Enter Username (it has to be an email)
- Enter your first name
- Enter your last name
- Enter your preferred Password
- Enter your Date of Birth
- Enter a picture of your face (THIS STEP IS REQUIRED)
- Use different pictures since or the database will throw an error if the pic isnt unique
- it will later be used as your Profile Picture and for facial recognition
- Press the Sign Up Button at the bottom of the form
Expected Results:
- The user is able to Sign up without any problem and the system will save the user's details onto the db.
- User will see an "Account created" confirmation popup
Logging into an Account:
Actions/Steps:
- Click Login on the navbar
- Enter your email in the field marked "Your Email"
- Enter your password in the field marked "Your Password", the password is case sensitive as usual
- Check the checkbox marked "Remember me" if you wish for the website/browser to save your cookies
and leave you logged into account when you visit the website again
- Press the Login Button at the bottom of the form
Expected Results:
- The user is able to login into their already existing account with no problems, where
- The user will see the "Medication Form" page in front of them, which is marked by the "/profile" page identifier in the URL
- If the user checked the "Remember me" checkbox, they are able to close the website, reopen it, and still be logged in.
- If the user did not check the "Remember me" checkbox, they will be required to login again when they close and reopen the website.
Creating a New Medication:
Actions/Steps:
- Login using your credentials
- Click on "Medform" on the navbar up top
- Scroll down and click on the "+" button at the bottom of the form to add another form
- The dosage field is number only, meant to take in the milligram dosage of the
medication
- Once you're done filling out the form, click submit at the bottom of the form
Expected Results:
- Upon successfully submitting, the page will refresh and the form will clear, marking that
your medication has been successfully submitted
Deleting a Medication:
Actions/Steps:
- Login using your credentials
- Create a new medication using the instructions above, if necessary
- Click on "Dashboard" on the navbar up top
- Scroll down and click on the "trashbin" button on the left side of entry you wish to delete
within the medication list
Expected Results:
- Upon successfully deleting, the page will refresh and the medication will disappear from
the medication list.
Viewing One's Medication Schedule:
Actions/Steps:
- Login using your credentials
- Create a new medication using the instructions above, if necessary
- Click on "Dashboard" on the navbar up top
- Scroll down and view your daily medication schedule on the left hand
side of the page, ensuring your medication is sitting at the correct
time of day
Expected Results:
- Upon successfully finding the medication schedule container, the user
will see their medication name clearly within that container
Viewing One's Medication Alert:
Actions/Steps:
- Login using your credentials
- Create a new medication using the instructions above, if necessary
- Click on "Dashboard" on the navbar up top
- View your daily medication red alert at the top of the page. NOTE: This must
be done at the same time of day that is entered in one's medication. The morning/
noon/night arbitrary times follow the following pattern:
Morning: 6 AM -> 12 PM
Noon: 12 PM -> 6 PM
Night 6 PM -> 6 AM
Please ensure you do this test during the same time range that is used for your
medication. If you do not wish to wait, please use the above instructions to create
a new medication for whatever time of day it is for you when you're performing this
test
Expected Results:
- Upon successfully finding the medication alert, the user will see their medication
name clearly within that alert.
!! MILESTONE DEMO 1 !!
v1.0.0 link : https://github.com/Capstone-Projects-2022-Spring/project-pill-io/releases/tag/v1.0.0
!! MILESTONE DEMO 2 !!
v2.0.0 link : https://github.com/Capstone-Projects-2022-Spring/project-pill-io/releases/tag/v2.0.0
!! MILESTONE DEMO 3 !!
v3.0.0 link : https://github.com/Capstone-Projects-2022-Spring/project-pill-io/releases/tag/v3.0.0