Skip to content

Commit

Permalink
Update the docs home page
Browse files Browse the repository at this point in the history
  • Loading branch information
francip committed Jun 9, 2024
1 parent b6ac94d commit ef48f60
Show file tree
Hide file tree
Showing 10 changed files with 83 additions and 75 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,4 @@ env.g.dart

# Jekyll
docs/_site/
.jekyll-metadata
28 changes: 14 additions & 14 deletions docs/_assembly/Build_the_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you received an unassembled Friend or want build one yourself, follow the ste

Ensure you've purchased all required components from the [buying guide] (https://docs.basedhardware.com/assembly/Buying_Guide/).

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/components.png" alt="components" width="300">
<img src="/images/latest_assembly/components.png" alt="components" width="300">

Download and print the case from the provided .stl file [link](https://github.com/BasedHardware/Friend/blob/main/3d-printing%20designs/Cover%20%2B%20Case.stl).

Expand All @@ -21,57 +21,57 @@ If you don't have access to a 3D printer, send the file to a 3D printing service

**Step 1.** Cut the *black wire* approximately 2/3" from the base.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/1.png" alt="battery" width="300">
<img src="/images/latest_assembly/1.png" alt="battery" width="300">

**Step 2.** Carefully remove *just a little bit* of insulation from both ends of the cut wire.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/2.png" alt="wire" width="300">
<img src="/images/latest_assembly/2.png" alt="wire" width="300">

The wire stripper should have multiple notches labeled with AWG sizes. For this project, we recommend using *28 AWG*.

**Step 3.** Follow the soldering diagram to connect the battery and board.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/3.png" alt="soldering" width="300">
<img src="/images/latest_assembly/3.png" alt="soldering" width="300">


**Step 4.** Ensure the switch is inserted securely into the battery connector.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/4.png" alt="battery" width="300">
<img src="/images/latest_assembly/4.png" alt="battery" width="300">

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/electronics.png" alt="status" width="300">
<img src="/images/latest_assembly/electronics.png" alt="status" width="300">

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/case.png" alt="status" width="300">
<img src="/images/latest_assembly/case.png" alt="status" width="300">

**Step 5.** Assemble the battery and board in the 3D printed case.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/5.png" alt="case" width="300">
<img src="/images/latest_assembly/5.png" alt="case" width="300">

**Step 6.** Place the switch in the notch next to the USB-C notch

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/6.png" alt="notch" width="300">
<img src="/images/latest_assembly/6.png" alt="notch" width="300">

**Step 7.** Gather the longer red wire and gently twist it.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/7.png" alt="twist" width="300">
<img src="/images/latest_assembly/7.png" alt="twist" width="300">

This will help manage the wires when putting on the lid.

**Step 8.** Curl the wire and place it off to the side.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/8.png" alt="twist" width="300">
<img src="/images/latest_assembly/8.png" alt="twist" width="300">

**Step 9.** Attach the lid to the case.

Attaching the lid may take a few tries; make sure to use the ridges as a guide to find the best placement.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/9.png" alt="lid" width="300">
<img src="/images/latest_assembly/9.png" alt="lid" width="300">

**Step 10.** Apply even pressure around the perimeter of the case until the seams snap in place.

<img src="https://basedhardware.github.io/Friend/images/latest_assembly/10.png" alt="seams" width="300">
<img src="/images/latest_assembly/10.png" alt="seams" width="300">


### Congratulations! you now have a fully working and assembled device!


[Next Step: Install Firmware →](https://basedhardware.github.io/Friend/assembly/Install_firmware/){: .btn .btn-purple }
[Next Step: Install Firmware →](/assembly/Install_firmware/){: .btn .btn-purple }
6 changes: 3 additions & 3 deletions docs/_assembly/Buying_Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ You have two options:
|Seeed Studio XIAO nRF52840 Sense Board | $15 on [Seedstudio](https://www.seeedstudio.com/Seeed-XIAO-BLE-Sense-nRF52840-p-5253.html) and $24 on [Amazon US](https://amzn.to/3TZD1pO), [Amazon EU](https://amzn.eu/d/3eG6gaA) and [India](https://robu.in/product/seeed-studio-xiao-nrf52840-sense-tinyml-tensorflow-lite-imu-microphone-bluetooth5-0/) | <$15/unit
|Rechargeable Battery | $7 on [Amazon US](https://amzn.to/3TXlE9f) | $7/unit
|Slider Switch | $8 for 30+ units [Amazon US](https://www.amazon.com/dp/B099MN9JFP/) and also [Amazon EU](https://www.amazon.de/dp/B0BTM3WQXN) and [Amazon UK](https://www.amazon.co.uk/dp/B09TVFF6KW/) but you only need one | <$1/unit
|Wires | [Amazon US](https://www.amazon.com/dp/B09X4629C1) |
|Case | [3D-print design of the case](https://github.com/BasedHardware/Friend/tree/main/assets/3d_printing_designs/Latest%20design) |
|Wires | [Amazon US](https://www.amazon.com/dp/B09X4629C1) |
|Case | [3D-print design of the case](https://github.com/BasedHardware/Friend/tree/main/assets/3d_printing_designs/Latest%20design) |

[Next Step: Build the device →](https://basedhardware.github.io/Friend/assembly/Build_the_device/){: .btn .btn-purple }
[Next Step: Build the device →](/assembly/Build_the_device/){: .btn .btn-purple }
10 changes: 5 additions & 5 deletions docs/_assembly/Install_firmware.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,25 @@ SKIP and INSTALL PRE-BUILT FIRMWARE: Looking into the git repository, in the [fi

2. In the nRF Connect Extension inside your VS Code, click "Open an existing application" and open the `firmware` folder from the root of this repo.

<img src="https://basedhardware.github.io/Friend/images/install_firmware_screenshot_1.png" alt="install_firmware_screenshot_1" width="100%">
<img src="/images/install_firmware_screenshot_1.png" alt="install_firmware_screenshot_1" width="100%">


3. In the application panel of the extension, click the "Add Build Configuration" icon.

<img src="https://basedhardware.github.io/Friend/images/addbuild.png" alt="Add Build Configuration" width="200">
<img src="/images/addbuild.png" alt="Add Build Configuration" width="200">

4. Choose the board as "xiao_ble_sense" and select the configuration as "prj.conf". Then, click "Build Configuration".

<img src="https://basedhardware.github.io/Friend/images/build_settings.png" alt="Build Settings" width="400">
<img src="/images/build_settings.png" alt="Build Settings" width="400">

5. Once the build succeeds, you will find the `zephyr.uf2` file in the `firmware/build/zephyr` directory.

6. Double-click on the reset button of the device. The device will appear on your computer as a disk. Drag and drop the `zephyr.uf2` file into it.

> **Note:** On a Mac, you might see an error message after dropping the file, indicating that the process did not complete. This is just a Mac-specific error; the firmware is successfully uploaded.
<img src="https://basedhardware.github.io/Friend/images/pinout.jpg" alt="Pinout" width="300">
<img src="/images/pinout.jpg" alt="Pinout" width="300">

That's it! You have successfully installed the firmware on your device.

[Next Step: Audio Test →](https://basedhardware.github.io/Friend/assembly/audio_test/){: .btn .btn-purple }
[Next Step: Audio Test →](/assembly/audio_test/){: .btn .btn-purple }
2 changes: 1 addition & 1 deletion docs/_developer/Contribution.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Contribution
nav_order: 3
nav_order: 4
---

# Contribution
Expand Down
29 changes: 29 additions & 0 deletions docs/_developer/HowItWorks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
layout: default
title: How It Works
nav_order: 3
---

# How it works

```mermaid
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
```
12 changes: 4 additions & 8 deletions docs/_get_started/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,14 @@ 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](https://docs.flutter.dev/get-started/install/macos/mobile-ios?tab=download) and [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
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
4. Install your environment variables for `apps/AppWithWearable`:
- You can copy .env.template file as .env and add your keys to it
- Or you can set the api keys needed on the mobile App from the settings page itself (enable Developer mode)
5. Build targets:
- iOS: Download/install [XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) 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](https://developer.android.com/studio) then navigate to the Android folder.
- Web/Simulator: Do not run in the web/simulator as 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 the selected device (iOS or Android).

[Next Step: Buying Guide →](https://basedhardware.github.io/Friend/assembly/Buying_Guide/){: .btn .btn-purple }
[Next Step: Buying Guide →](/assembly/Buying_Guide/){: .btn .btn-purple }
2 changes: 1 addition & 1 deletion docs/_info/Disclaimer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ nav_order: 4

Please note that the Friend is a prototype project and is provided “as is”, without warranty of any kind. Use of the device should comply with all local laws and regulations concerning privacy and data protection.

<img src="https://basedhardware.github.io/Friend/images/disclaimer.png" alt="disclaimer" width="100%">
<img src="/images/disclaimer.png" alt="disclaimer" width="100%">

Thank you for your interest in Friend, the open-source AI wearable. We’re excited to see what you’ll build with it!
10 changes: 5 additions & 5 deletions docs/_info/archive/launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Friend is an AI wearable device that records everything you say, gives you proac

## How it works

<img src="https://basedhardware.github.io/Friend/images/how_it_works.png" alt="how_it_works " width="300">
<img src="/images/how_it_works.png" alt="how_it_works " width="300">

## Structure

Expand Down Expand Up @@ -96,23 +96,23 @@ Follow these steps to install the firmware:

2. In the nRF Connect Extension inside your VS Code, click "Open an existing application" and open the `firmware` folder from the root of this repo.

<img src="https://basedhardware.github.io/Friend/images/vscode_extension.png" alt="VS Code Extension" width="200">
<img src="/images/vscode_extension.png" alt="VS Code Extension" width="200">

3. In the application panel of the extension, click the "Add Build Configuration" icon.

<img src="https://basedhardware.github.io/Friend/images/addbuild.png" alt="Add Build Configuration" width="200">
<img src="/images/addbuild.png" alt="Add Build Configuration" width="200">

4. Choose the board as "xiao_ble_sense" and select the configuration as "prj.conf". Then, click "Build Configuration".

<img src="https://basedhardware.github.io/Friend/images/build_settings.png" alt="Build Settings" width="400">
<img src="/images/build_settings.png" alt="Build Settings" width="400">

5. Once the build succeeds, you will find the `zephyr.uf2` file in the `firmware/build/zephyr` directory.

6. Double-click on the reset button of the device. The device will appear on your computer as a disk. Drag and drop the `zephyr.uf2` file into it.

> **Note:** On a Mac, you might see an error message after dropping the file, indicating that the process did not complete. This is just a Mac-specific error; the firmware is successfully uploaded.
<img src="https://basedhardware.github.io/Friend/images/pinout.jpg" alt="Pinout" width="300">
<img src="/images/pinout.jpg" alt="Pinout" width="300">

That's it! You have successfully installed the firmware on your device.

Expand Down
58 changes: 20 additions & 38 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,54 +4,36 @@ title: Introduction
nav_order: 1
---

# Introduction
<img src="/images/mainbanner.jpeg" alt="Friend Banner" width="100%">

Friend is an AI wearable device that records everything you say, giving you proactive feedback and advice. Use these docs to unlock the full potential of Friend and build using the power of recall.
# Introduction

<img src="https://basedhardware.github.io/Friend/images/mainbanner.jpeg" alt="Friend Banner" width="100%">
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.

## 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

## How it works

```mermaid
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
```
- Open-Source: Fully open-source, empowering you to customize and enhance your experience.
- Long Battery Life: 24+ hour battery ensures you stay connected all day.
- Live Transcription: Capture live voice and audio with human-level accuracy using OpenAI Whisper and Deepgram.
- Conversation Memory: Remembers conversations, providing you with reliable records.
- Efficient Summarization: Get instant insights and summaries powered by ChatGPT in just 5 seconds.
- Connectivity: Bluetooth enabled with WiFi, LED, accelerometer, and USB-C charging.
- App Marketplace: Expand functionality with our app marketplace.
- Conversation Coach: Friend helps you communicate better, gives you tips and advises during conversations.

## Structure
## Software

There are 3 different apps in these repositories located in different branches and folders. Our goal is to merge them into one big project.
[<img src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' alt='Get it on Google Play' width="230px">](https://play.google.com/store/apps/details?id=com.friend.ios)
[<img src="https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/en-us?size=250x83" alt="Download on App Store" style="width: 180px; margin-bottom: 15px;">](https://apps.apple.com/us/app/friend-ai-wearable/id6502156163)

Folder "AppStandalone": Standalone version of the app that doesn't require any hardware to use it.
iOS app beta on [TestFlight](https://testflight.apple.com/join/Ie8VQ847)

Folder "AppWithWearable": Wearable-connected version of the app that requires the "Friend necklace" to use it.
Latest firmware: [v1.0.2](https://github.com/BasedHardware/Friend/releases/download/v1.0.2-Firmware/friend-firmware.uf2)

Folder "AppWithWearableReactNative": Wearable-connected version of the app that is built in React native
There are also alternative apps and firmware compatible with Friend:

[Glassium](https://glassium.org/) - a mobile and web app for AI wearables and Agents.

[Bubble Firmware](https://github.com/ex3ndr/bubble-firmware) - a universal firmware for open-source AI pendants.

[Next Step: Getting Started →](https://basedhardware.github.io/Friend/get_started/Setup/){: .btn .btn-purple }
[Next Step: Getting Started →](/get_started/Setup/){: .btn .btn-purple }

0 comments on commit ef48f60

Please sign in to comment.