COMSATS University Islamabad (CUI)

Attock Campus

Software Requirement Specification

SRS (DOCUMENT)

for

My Eye Companion

Version 1.0

By:
Hamad Ahmed CIIT/FA21-BSE-050/ATK
M. Hassaan Saeed CIIT/FA21-BSE-038/ATK

Supervisor:
Mr. Umer Zia

Bachelors of Science in Software Engineering (2021-2025)

 R EVISION H ISTORY

Name Date Reason for Changes Version

i
 A PPLICATION E VALUATION H ISTORY

Comments (by committee) Action Taken

Language Model for Content Generation

Screen Time Recording Module
Scope is limited

Supervised By
Mr. Umer Zia

ii
 Table of Contents

Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Chapter One: Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.1 Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Modules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.4 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter Two: Overall Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.1 Product Perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 User classes and characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.3 Operating Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.4 Design and Implementation Constraints . . . . . . . . . . . . . . . . . . . . . 4

Chapter Three: Requirement Identifying Technique . . . . . . . . . . . . . . . . . . 6

4 Functional Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.1 User Profile Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2 Eye Disease Detection Module . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.3 Eye Exercise Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.4 Screen Time Monitoring and Reminders . . . . . . . . . . . . . . . . . . . . . 7
4.5 Community Forum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.6 AI Chatbot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Chapter Five: External Interface Requirements . . . . . . . . . . . . . . . . . . . . 10

5.1 User Interface Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.2 Software Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.3 Hardware Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.4 Communication Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter Six: Non-Functional Requirements . . . . . . . . . . . . . . . . . . . . . . . 12

6.1 Performance Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.2 Reliability Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.3 Usability Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.4 Security Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
6.5 Maintainability Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 13
6.6 Portability Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
6.7 Compatibility Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

iii
 Chapter One: Introduction

1.1 Purpose

The purpose of the "My Eye Companion" application is to provide eye care solutions to individ-
uals suffering from eye issues or aiming to maintain eye health. The app leverages AI to detect
eye diseases, AI chatbot to answer eye related queries, provides exercises for eye care, sets
screen time alarms to prevent eye strain, and facilitates community discussions through a fo-
rum. This document is intended for the developers, project manager, testers, and documentation
writers involved in building and maintaining the app.

1.2 Scope

"My Eye Companion" is a mobile application designed to assist users in maintaining eye health
and addressing eye related concerns. The app’s AI-driven disease detection module can detect
common eye conditions like crossed eyes, bulging eyes and conjunctivitis. It also offers various
eye exercises and sets reminders to limit screen time. Through the AI chatbot and community
forum, users can engage with personalized advice and discussions. This software will serve as
a daily companion for users, integrating health management and social support into a unified
platform.

1.3 Modules

1. Login/Sign Up Module (M1): Enables users to create an account or log in securely.

2. AI Eye Disease Detection Module (M2): Utilizes machine learning algorithms to analyze
user input image, to detect early signs of common eye diseases/disorders like crossed eyes,
bulging eyes, and conjunctivitis. Disease detection directly from the eye image.

3. Eye Exercises Module (M3): Provides a series of eye exercises designed to strengthen the
eyes and reduce strain, based on user preferences and conditions. Providing an effective way to
maintain eye care routine.

4. AI Chatbot Module (M4): An AI-powered assistant that answers user queries in real time
and provides eye health advice.

5. Community Forum Module (M5): A social platform for users to share experiences, ask
questions, and offer advice on eye health, creating a supportive environment.

1
6. Screen Time Alarms Module (M6): Allows users to set and customize alarms that remind
them to take breaks from screens to prevent eye strain. Custom notification message can be set.

7. Settings Module (M7): Allows users to customize their app experience, including notifi-
cation settings and personal preferences.

1.4 Overview

This document outlines the software requirements for the "My Eye Companion" application.
Chapter 2 will provide an overall description of the product, including the user environment,
while Chapter 3 covers the techniques used for requirements gathering. Chapter 4 describes the
functional requirements of the system, and Chapter 5 details the external interfaces. Finally,
Chapter 6 addresses non-functional requirements like reliability and security.

2
 Chapter Two: Overall Description

2.1 Product Perspective

"My Eye Companion" is an innovative mobile application designed to address the growing need
for better eye care management. This app is a new product developed as a final-year project,
leveraging AI technologies to help users maintain eye health. It is not an extension of an existing
product but a comprehensive solution targeting individual eye health management.

Figure 1: Data Flow Diagram

2.2 User classes and characteristics

Primary Users:

1. Routine Users: Individuals concerned about their eye health. They require guidance about
eye care and are interested in performing eye exercises to prevent eye stress in their daily life.

2. Eye Patients: Individuals having eye disorders or diseases such as conjunctivitis, crossed
eyes, or bulging eyes. They require regular advice and a routine to recover to a better state.

3. Researchers: Users who want to research on existing work done and think about the
innovations.

3
2.3 Operating Environment

OE-1: The application shall operate on Android devices running version 8.0 (Oreo) or later and
iOS devices running version 13 or later.

OE-2: The system shall function on smartphones equipped with a minimum of 2 GB RAM
and cameras with at least 8 MP resolution for accurate eye disease detection.

OE-3: The application shall require an active internet connection for AI-based disease de-
tection, chatbot functionality, and community forum participation. Offline features like eye
exercises and screen time reminders shall remain operational without connectivity.

OE-4: The system shall interact with APIS, for AI operations and Firebase for real-time
database and authentication.

OE-5: The app shall function properly on devices with screen sizes ranging from 5 inches
to 7.5 inches, ensuring proper UI adaptability across common smartphones.

OE-6: The app shall support notifications using the default Android and iOS notification sys-
tems for reminders and alerts.

2.4 Design and Implementation Constraints

CON-1 The application shall be developed using the Flutter framework to ensure cross-platform
compatibility for Android and iOS.

CON-2 All data must be stored using Firebase’s real-time database, adhering to secure storage
and retrieval protocols.

CON-3 The AI-based disease detection module must be developed using Python for standard-
ized model training.

CON-4 State management must be used to ensure data access with in app on different places.

CON-5 Screen layouts must adapt dynamically to support devices with screen sizes ranging
from 5 inches to 7.5 inches.

4
CON-6 Payments for any premium features (if introduced) shall be processed only through
secure gateways like Google Pay.

CON-7 The app shall not include third-party advertisements to maintain user trust and focus
on health management.

5
 Chapter Three: Requirement Identifying Technique

The following requirement identification techniques were utilized for "My Eye Companion"
to derive its functional and non-functional requirements:

• Brainstorming Group discussions were conducted to analyze and refine the required func-
tionalities of the application. These sessions focused on prioritizing the features to be
included, such as AI Eye Disease Detection, Eye Exercises, and Screen Time Alarms.
The group also deliberated on various domains and finalized the focus on eye health and
its associated challenges.

• Reviewing Blogs Extensive internet research was carried out to identify trends and gaps
in existing eye care technologies. Blogs and articles provided insights into unaddressed
user needs, such as the integration of personalized AI-driven eye health solutions and a
community-driven approach for users to share experiences.

• Reviewing Existing Applications Several existing applications in the domain of eye care
and health management were tested and analyzed. This hands-on exploration helped in
identifying limitations and areas for improvement, such as the lack of community forums
and effective AI chatbots tailored for eye-related queries. This analysis also inspired the
introduction of innovative features to enhance user experience and functionality.

• Storyboarding Visual storyboards for key features like Eye Exercises, AI Chatbot, and
Community Forum were created to refine the user interface and experience. These sto-
ryboards helped map out screen navigation, element placement, and feature interaction
flow.

6
 Chapter 4

Functional Requirements

4.1 User Profile Management

4.2 Eye Disease Detection Module

4.3 Eye Exercise Module

4.4 Screen Time Monitoring and Reminders

4.5 Community Forum

4.6 AI Chatbot

7
 Table 1: Description of FR-1 - User Profile Management

Identifier FR-1
Title User Profile Management
Requirement The system shall allow users to create and manage their pro-
files, including personal information such as name, age, and
gender.
Source End-user requirements
Rationale Enable personalization and tailored app experiences for
users.
Business Rule (if re- Profiles must be editable and stored securely in the backend
quired) database.
Dependencies None
Priority High

Table 2: Description of FR-2 - Eye Disease Detection

Identifier FR-2
Title Eye Disease Detection
Requirement The system shall enable users to upload or capture eye im-
ages for AI-based predictions of conditions such as crossed
eyes, bulging eyes, conjunctivitis, or normal.
Source Medical research on eye issues
Rationale Provide users with an automated solution for early detection
of eye conditions.
Business Rule (if re- AI predictions must be processed within 5 seconds per im-
quired) age.
Dependencies FR-1 (User Profile Management)
Priority High

Table 3: Description of FR-3 - Eye Exercise Module

Identifier FR-3
Title Eye Exercise Module
Requirement The system shall provide guided exercises categorized
based on specific eye conditions, including voice and visual
instructions accompanied by calming background audio.
Source Medical research on eye care
Rationale Help users perform exercises that reduce eye strain and im-
prove eye health.
Business Rule (if re- Exercises must be categorized and available for playback
quired) with offline support.
Dependencies FR-1 (User Profile Management)
Priority High

8
 Table 4: Description of FR-4 - Screen Time Monitoring

Identifier FR-4
Title Screen Time Monitoring and Reminders
Requirement The system shall track screen time and send notifications
or reminders to take breaks, allowing users to set reminders
with a custom message displayed when the screen time limit
is reached.
Source User feedback on screen fatigue
Rationale Reduce the risk of digital eye strain caused by prolonged
screen time.
Business Rule (if re- Reminders must be customizable with user-defined
quired) message.
Dependencies None
Priority Medium

Table 5: Description of FR-5 - Community Forum

Identifier FR-5
Title Community Forum
Requirement The system shall facilitate discussions and knowledge
sharing among users regarding eye health and well-being
through messages.
Source End-user requirement
Rationale Create a platform for peer support and community learning.
Business Rule (if re- None
quired)
Dependencies FR-1 (User Profile Management)
Priority Low

Table 6: Description of FR-6 - AI Chatbot

Identifier FR-6
Title AI Chatbot
Requirement The system shall provide personalized advice and respond
to user queries about eye care and health issues.
Source Health professionals feedback
Rationale Enhance user experience by offering instant, AI-driven ad-
vice on eye-related issues.
Business Rule (if re- Responses must include links to trusted sources for further
quired) reading.
Dependencies FR-1 (User Profile Management), FR-5 (Community Fo-
rum)
Priority High

9
 Chapter Five: External Interface Requirements

This section provides information to ensure that the system will communicate properly with
users and with external hardware or software elements. A complex system with multiple sub-
components should create a separate interface specification or system architecture specification.
The interface documentation could incorporate material from other documents by reference.
For instance, it could point to a hardware device manual that lists the error codes that the device
could send to the software.

5.1 User Interface Requirements

The user interfaces for "My Eye Companion" are designed to be intuitive, user-friendly, and
visually appealing. The key requirements for the interfaces include:

• GUI Standards: The app shall adhere to Android and iOS design standards, ensuring
consistency with user expectations on each platform.
• Screen Layouts and Resolution: The application shall adapt to screen sizes ranging from
5 to 7.5 inches, including appropriate font scaling and image resizing.
• Standard Controls: The app shall include commonly used elements such as:
– Navigation menu with equally sized icons and text labels.
– Consistent font size and style.
• Customization Options: Users shall have the ability to change the app’s language and
customize notifications and reminders.
• Localization: Support shall be provided for multiple languages to cater to a diverse user
base.
• Error and Feedback Messages: Clear and concise messages shall guide users in the event
of issues such as invalid login credentials.

5.2 Software Interfaces

"My Eye Companion" interacts with the following software components to deliver its features:

• AI Models: Integration with MobileNetV2 for real-time disease detection.

• Database and Authentication:
– Firebase Firestore Database for storing user data securely.
– Firebase Authentication for managing user logins and sign-ups.
• Chatbot Functionality: API connections to an AI-powered chatbot engine.
• Eye Exercises: Integration with text-to-speech functionality to provide audio instructions.

10
 • Community Forum: Firebase Firestore to store and fetch user messages.
• Notifications: Use of Android and iOS native push notification systems for reminders (e.g.,
screen time alarms).
• Profile Management: Integration with the Provider package for efficient state management
and displaying user details across the app.

5.3 Hardware Interfaces

The application interacts with various hardware components to deliver core functionalities:

• Camera Requirements: The device must have a minimum camera resolution of 8 MP for
accurate eye disease detection.
• Device Requirements: Supported smartphones must meet the following criteria:
– Android OS 8.0 or later.
– iOS 13.0 or later.
– At least 2 GB of RAM.

5.4 Communication Interfaces

The app communicates with users and external systems through the following methods:

• Push Notifications: Push notifications shall be integrated for reminders, updates, and alerts
(e.g., screen time alarms).

11
 Chapter Six: Non-Functional Requirements

This section specifies nonfunctional requirements other than constraints, which are recorded
in section 2.3, and external interface requirements, which will appear in section 7. These quality
requirements should be specific, quantitative, and verifiable. Chapter 14 “beyond functionality”
presents more information about these quality attribute requirements and many examples. The
following requirements ensure that the "My Eye Companion" application performs effectively,
efficiently, and securely while providing a high-quality user experience.

6.1 Performance Requirements

State specific performance requirements for various system operations.

• The application shall load the splash screen within 4 seconds on devices meeting the mini-
mum hardware specifications.
• The AI disease detection model shall provide results within 9 seconds of image submission
for typical cases.
• The app shall support up to 1,000 concurrent users without significant performance degra-
dation, scaling with Firebase resources as needed.

6.2 Reliability Requirements

Requirements about how often the software fails and the recovery measures in case of failures.

• Functionality such as user login must recover within 1 minute after a system crash.
• Data submitted by users (e.g., uploaded images or forum posts) shall not be lost even in the
event of a server crash, leveraging Firebase’s Firestore database.

6.3 Usability Requirements

Usability requirements deal with ease of learning, ease of use, error avoidance and recovery,
and efficiency of interactions.

• The application must allow users to complete key tasks (e.g., submitting an eye image for
analysis) in no more than 3 steps.
• The application must maintain consistent styling across all screens.

6.4 Security Requirements

Security requirements focus on protecting the system and its data.

12
 • The application shall securely store user details and authentication information in Firebase
Firestore, linked to unique user IDs (UIDs).

6.5 Maintainability Requirements

Requirements regarding the ease of updating and fixing the system.

• The app’s codebase shall be modular to facilitate feature updates and bug fixes.

6.6 Portability Requirements

Portability requirements deal with the compatibility of the system across platforms and devices.

• The application shall support devices running Android 8.0 and above, and iOS 13.0 and
above.
• The app must function on a wide range of smartphones, adjusting for screen sizes between
5 and 7.5 inches.

6.7 Compatibility Requirements

Compatibility requirements ensure the software works seamlessly on different devices.

• The app shall be compatible with different mobile device screen sizes.

13