Giter VIP home page Giter VIP logo

all-ears_android's Introduction

✅ How to run

1) Prerequisites

Client of "All Ears" is a WearOS application and requires the following dependencies. Make sure to have the correct dependencies for the project.

  • java version: 8
  • kotlin version: 1.7.20
  • gradle version: 8.2
  • android: Hedgehog | 2023.1.1 Patch 1
  • complie SDK version: API 34
  • Android Studio

2) Clone

Clone this repository to your local computer using:

https://github.com/TeamAllways-AllEars/All-Ears_Android.git

3) GCP resource

Client of "All Ears" uses the GCP STT API for Live Captioning. Please create a Service account for STT in GCP and apply the JSON key file in your project.

allears-architecture-android

Client of "All Ears" uses the GCP STT API for Live Captioning. To run this code with your GCP resource, make sure to apply your API key for the GCP STT API Service account in the app/src/main/res/raw/credential_allwaysallears.json file (❗Do not change the directory or file name❗). Please create a Service account for STT in GCP and apply the JSON key file in your project. The format of your JSON API key file should look like this:

{
  "type": "service_account",
  "project_id": "...",
  "private_key_id": "...",
  "private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
  "client_email": "...",
  "client_id": "...",
  "auth_uri": "...",
  "token_uri": "...",
  "auth_provider_x509_cert_url": "...",
  "client_x509_cert_url": "...",
  "universe_domain": "..."
}

You also need to provide the base url for your SpringBoot backend server in app/src/main/java/gdsc/allways/allears/presentation/subtitles/SubtitleService.kt file. Make GCP VM for backend server, attach static external IP to the VM instance(refer to All-Ears_Server repository), and provide the info of static external IP to the BASE_URL val in SubtitleService.kt file.

private const val BASE_URL = "http://<static external IP>:8080"

⌚ Device

"All Ears" was tested on the Galaxy Watch 4, which has an ARM Mali-G68 MP2 667 MHz GPU. If you are planning to run this code on a device, make sure your edgy device has the same or higher GPU specs.

  • Galaxy watch 4 (44mm)
  • ARM Mali-G68 MP2 667 MHz GPU

⚙️ Architecture

Wear OS Tensorflow Lite GCP STT
allears-architecture-android

all-ears_android's People

Contributors

neoseurae12 avatar jeonhaeseung avatar yeji0214 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.