Skip to content

README.md

Latest commit

 

History

History
55 lines (45 loc) · 1.99 KB

README.md

File metadata and controls

55 lines (45 loc) · 1.99 KB
Raw

ClarIAr Project

Project made for Trilha's Hackathon and for all visually impaired people!

Project Image

Members:

What is it about?

ClarIAr is a feature created to upgrade the functionality of TalkBack, improving the experience for visually impaired users in Android smartphones. It implements Artificial Intelligence to describe images on the screen with more accuracy and details. In other words, ClarIAr is an accessibility resource created to enable blind people to use their phones in a more efficient way!

Project Workflow

Technical Setup

Prerequisites

  • Android Studio
  • Groq API Key

API Key configuration

  1. Create a file secrets.xml in app/src/main/res/values/
  2. Add your Groq API key:
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="groq_api_key">YOUR_GROQ_API_KEY_HERE</string>
</resources>

Creating an Android Emulator

  1. Open Android Studio
  2. Click on "Tools" > "Device Manager"
  3. Click "Create Device"
  4. Select a device definition (e.g., Pixel 4)
  5. Choose a system image (recommended: latest stable Android version)
  6. Name your virtual device and finish setup

Running the application

Using Emulator

  1. Launch the created virtual device
  2. Open the project in Android Studio
  3. Click "Run" (green play button)
  4. (Make sure your computer Virtualization* is on)

*Virtualization: can be turned on in your PC's BIOS settings

Using physical device

  1. Enable Developer Options on your Android phone
  2. Enable USB Debugging
  3. Connect phone via USB
  4. Authorize the connection on your device
  5. Select your device in Android Studio's device dropdown
  6. Click "Run"