Friend

Meet Friend, the world’s leading open-source AI wearable that revolutionizes how you capture and manage conversations. Simply connect Friend to your mobile device and enjoy automatic, high-quality transcriptions of meetings, chats, and voice memos wherever you are.

       

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:

• Introduction
• App setup
• Buying Guide
• Build the device
• Install firmware

To start developing:

• Check out our contributions guide
• Check current tasks
• Check paid bounties here
• Join Discord

How it works

graph TD;
   A[Device] -- Streams Audio --> B[Phone App];
   B -- Transmits --> C[Deepgram];
   C -- Returns Transcript --> D[Phone App];
   D -- Sends Transcript to Plugins Enabled --> G[Community Plugins];
   D -- Saves Original Transcript --> E[Phone Storage];
   G -- Saves Plugin Responses --> E;

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,G lightMode;
class A,B,C,D,E,G darkMode;

linkStyle 0 stroke:#FF4136, stroke-width:2px;
linkStyle 1 stroke:#1ABC9C, stroke-width:2px;
linkStyle 2 stroke:#0074D9, stroke-width:2px;
linkStyle 3 stroke:#FFCC00, stroke-width:2px;
linkStyle 4 stroke:#2ECC40, stroke-width:2px;
linkStyle 5 stroke:#B10DC9, stroke-width:2px;

Loading

Get the software

Get the Android app on Google Play

Download the iOS app in App Store

iOS app beta on TestFlight

Latest firmware: v1.0.2

Or you can build your own app from the sources in apps/AppWithWearable and firmware from firmware folders.

Next Step: Read Getting Started →

Getting Started

Follow these steps to get started with your Friend.

Install the app

Before starting, make sure you have the following installed:

• Flutter SDK
• Dart SDK
• Xcode (for iOS)
• Android Studio (for Android)
• CocoaPods (for iOS dependencies)

Setup Instructions

1. Upgrade Flutter: Before proceeding, make sure your Flutter SDK is up to date:

   flutter upgrade
   

2. Get Flutter Dependencies: From within apps/AppWithWearable, install flutter packages:

   flutter pub get
   

3. Install iOS Pods: Navigate to the iOS directory and install the CocoaPods dependencies:

   cd ios
   pod install
   pod repo update
   

4. Environment Configuration: Create .env using template .env.template

   cd ..
   cat .env.template > .env
   

5. API Keys: Add your API keys to the .env file. (Sentry is not needed)

6. Run Build Runner: Generate necessary files with Build Runner:

   dart run build_runner build
   

7. Setup Firebase:

   • Follow official Firebase Docs till Step 1

   • Run the following command to register the prod flavor of the app. The command will prompt you to select configuration type; under it, select Target and then Runner

     flutterfire config --out=lib/firebase_options_prod.dart --ios-bundle-id=com.friend-app-with-wearable.ios12 --android-app-id=com.friend.ios --android-out=android/app/src/prod/  --ios-out=ios/Config/Prod/
     

   • Similarly for dev environment

     flutterfire config --out=lib/firebase_options_dev.dart --ios-bundle-id=com.friend-app-with-wearable.ios12.develop --android-app-id=com.friend.ios.dev --android-out=android/app/src/dev/  --ios-out=ios/Config/Dev/
     

   • Generate SHA1/SHA256 Keys for your Keystore and add them to Firebase. Follow the steps mentioned in this StackOverflow answer or the Official Docs. This is required for Firebase Auth through Google OAuth to work.

8. Run the App:

   • Select your target device in Xcode or Android Studio.
   • Run the app.

Next Step: Buying Guide →

More links:

• Contributing
• Roadmap and Tasks
• Support
• Our bluetooth Protocol Standard
• Plugins

Made by the Community, with -❤️-:

Licensing

Friend is available under MIT License