From 3be243925fc3c75d7f20ec8087f33eb3ac55bb41 Mon Sep 17 00:00:00 2001 From: Eyuep Sueyruege Date: Sat, 24 Feb 2024 11:37:35 +0100 Subject: [PATCH] Add user --- user.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 user.md diff --git a/user.md b/user.md new file mode 100644 index 0000000..045ee06 --- /dev/null +++ b/user.md @@ -0,0 +1,43 @@ +## Table of Contents + +* [Purpose of User Documentation](#purpose-of-user-documentation) +* [Motivation and Functions of the Project](#motivation-and-functions-of-the-project) +* [Usage of the Project](#usage-of-the-project) + +## Purpose of User Documentation + +The following user documentation aims to present the functions of the Playing Card Recognition for Blind People Interdisciplinary Project-13 and explain them in a clear manner to facilitate easy usage of the software. This includes showcasing and describing the usage of the project step by step. + +## Usage of the Project + +To use the product: + +1. Plug in the device via micro USB to your local device for power supply. +2. Plug in a microjack headset for audio output. +3. Scan your cards using the device. + + +Instructions for installing the product for the first time: + +## Attention! : These steps need to be done once if the device has to be set up for the first time. However, you can skip this if the upload process has already been completed. + +1. Clone the Git repository to your local device. +2. Install necessary tools like Arduino IDE and the necessary libraries needed for the implementation. +3. Plug in the product's ESP32 with a micro USB to your local device. +4. Go to the file folder downloaded from the Git repository. +5. Navigate to `src -> arduino`. +6. Open the Arduino sketch "whisperingSight.ino". +7. Select the ESP32 Dev Module from the sketch configurations in the navbar and choose the right port. +8. Upload your code. + +## Motivation and Functions of the Project + +The goal of the Playing Card Recognition for Blind People Interdisciplinary Project-13 was to develop a system that enables visually impaired individuals to recognize playing cards using technology. The motivation behind this project was to enhance accessibility and inclusion for visually impaired people in card games and other related activities. + +The functions of the project include: + +* Recognition of playing cards using NFC/ESP32/DF-Player Modules. +* Auditory output to communicate the recognized card to the user. +* Integration with a microjack headset for audio output. +* User-friendly interface for easy interaction. +