Skip to content

Latest commit

 

History

History
109 lines (72 loc) · 4.71 KB

README.md

File metadata and controls

109 lines (72 loc) · 4.71 KB
Raw

Friend

Open Source AI Wearable device that records everything you say, gives you proactive feedback and advice. 24h+ on single charge.

Friend Image

Discord Follow     License: MIT    GitHub Repo stars

Homepage | Documentation | Buy Assembled Device

Features

  • Real-Time AI Audio Processing: Leverage powerful on-device AI capabilities for real-time audio analysis.
  • Low-powered Bluetooth: Capture audio for 24h+ on a small button battery
  • Open-Source Software: Access and contribute to the pin's software stack, designed with openness and community collaboration in mind.
  • Wearable Design: Experience unparalleled convenience with ergonomic and lightweight design, perfect for everyday wear.

Get Started with our Documentation:

How it works

graph TD;
   A[Device] -- Streams Audio --> B[Phone App];
   B -- Transmits --> C[Deepgram];
   C -- Returns Transcript --> D[Phone App];
   D -- Saves Transcript --> E[Phone Storage];

classDef lightMode fill:#FFFFFF, stroke:#333333, color:#333333;
classDef darkMode fill:#333333, stroke:#FFFFFF, color:#FFFFFF;

classDef lightModeLinks stroke:#333333;
classDef darkModeLinks stroke:#FFFFFF;

class A,B,C,D,E lightMode
class A,B,C,D,E darkMode

linkStyle 0 stroke:#FF4136, stroke-width:2px
linkStyle 1 stroke:#1ABC9C, stroke-width:2px
linkStyle 2 stroke:#FFCC00, stroke-width:2px
linkStyle 3 stroke:#2ECC40, stroke-width:2px

Structure

There are 3 different apps in these repositories located in different branches and folders. Our goal is to merge them into one big project.

Folder "AppStandalone": Standalone version of the app that doesn't require any hardware to use it.

Folder "AppWithWearable": Wearable-connected version of the app that requires the "Friend necklace" to use it.

Folder "AppWithWearableReactNative": Wearable-connected version of the app that is built in React native

Next Step: Read Getting Started →

Getting Started

Follow these steps to get started with your Friend.

Install the app

  1. Clone the repo git clone https://github.com/BasedHardware/friend.git

  2. Choose which version of the app you want to install (see Structure).

    • Don't have the device? run cd apps/AppStandalone in terminal
    • Have the device/NRF Board? run cd apps/AppWithWearable in terminal

  3. Install Flutter and CocoaPods

  4. Install your environment variables

    • For AppStandalone, update variables in in .env.template file
    • For AppWithWearable, you can set the api keys needed on the mobile App from the settings page itself

  5. iOS: Install XCode then navigate to the iOS folder. You might need to launch Xcode to select a team and specify a bundle identifier. Android: Download/install android Studio then navigate to the Android folder Don't run in web/simulator: Bluetooth will not work

  6. Run flutter clean then flutter pub get then pod install

  7. When everything is installed, run flutter run , this should run your app on a selected device

Next Step: Buying Guide →

More links:

Made by the Community, with -❤️-:

Licensing

Friend is available under MIT License