images

BasedHardware · May 1, 2024 · 79245c3 · 79245c3
1 parent 45ce967
commit 79245c3
Show file tree

Hide file tree

Showing 10 changed files with 93 additions and 4 deletions.
diff --git a/docs/_assembly/Build_the_device.md b/docs/_assembly/Build_the_device.md
@@ -10,3 +10,31 @@ If you purchased an unassembled Friend device or built it yourself using our har
 
 {: .note }
 Important: If you purchased an assembled device please skip this step
+
+
+**Step 0:** Make sure you have bought everything from the buying guide above
+
+<img src="https://basedhardware.github.io/Friend/images/build_device_snapshot_1.png" alt="Components" width="300">
+
+**Step 1:** You need to design the case using 3D printer. Find .stl file [here](https://github.com/BasedHardware/Friend/blob/main/3d-printing%20designs/Cover%20%2B%20Case.stl). If you don't know how to do it, send this file to someone who has a 3d printer
+
+**Step 2:**
+Solder everything together like on the picture below. using a soldering kit. Don't have it? buy [this one for $9](https://a.co/d/0XdthUV)
+
+<img src="https://basedhardware.github.io/Friend/images/build_device_snapshot_2.png" alt="Soldering" width="400">
+
+<img src="https://basedhardware.github.io/Friend/images/build_device_snapshot_3.png" alt="Soldered" width="300">
+
+**Step 3:**
+Fit everything in the case. Biggest hole is for the usb port. In my example, I put the battery first, then the board and then the switch, however it's not an ideal design. If you will figure out a better solution, please contribute!
+
+<img src="https://basedhardware.github.io/Friend/images/build_device_snapshot_4.png" alt="Assembled" width="300">
+
+**Step 4:** Use hot glue to attach the lid to the case. You can also use a scotch tape first for testing purposes. Last, on the USB-port side, you'll find 2 small round holes. This is where the thread should go through.
+
+<img src="https://basedhardware.github.io/Friend/images/build_device_snapshot_5.png" alt="Lid" width="200">
+
+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 }
diff --git a/docs/_assembly/Install_firmware.md b/docs/_assembly/Install_firmware.md
@@ -12,7 +12,59 @@ If you purchased an unassembled Friend device or built it yourself using our har
 Important: If you purchased an assembled device please skip this step
 
 
+We have uploaded a build of the firmware in `firmware/Build`, that will always contain the most up to date build of the firmware. To use this firmware please download it and follow step 6 below. If you would like to build the firmware yourself please follow all the steps below.
+
 1. Set up nRF Connect by following the tutorial in this video: [https://youtu.be/EAJdOqsL9m8](https://youtu.be/EAJdOqsL9m8)
-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%">
+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%">
+
+
+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">
+
+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">
+
+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">
+
+That's it! You have successfully installed the firmware on your device.
+
+### Testing Audio Recording on Your Computer
+
+Follow these steps to test audio recording on your computer using a Python script:
+
+1. Open your terminal and navigate to the project's root directory.
+
+2. Change to the "test" folder:
+
+   ```
+   cd test
+   ```
+
+3. Install the required Python modules:
+
+   ```
+   pip install -r requirements.txt
+   ```
+
+4. Run the Python script:
+
+   ```
+   python local_laptop_client.py
+   ```
+
+The recorded audio files will be stored periodically in the `test/recordings` directory.
+
+That's it! You have now set up and tested audio recording on your computer.
+
+[Next Step: Audio Test →](https://basedhardware.github.io/Friend/assembly/audio_test/){: .btn .btn-purple }
diff --git a/docs/_assembly/audio_test.md b/docs/_assembly/audio_test.md
@@ -0,0 +1,9 @@
+---
+layout: default
+title: Audio Test
+nav_order: 4
+---
+
+# Audio Test
+
+
diff --git a/docs/_get_started/Setup.md b/docs/_get_started/Setup.md
@@ -40,4 +40,4 @@ Follow these steps to get started with your Friend.
 
 
 
-[Build the device →](https://basedhardware.github.io/Friend/assembly/Build_the_device/){: .btn .btn-purple }
+[Next Step: Build the device →](https://basedhardware.github.io/Friend/assembly/Build_the_device/){: .btn .btn-purple }
diff --git a/docs/images/build_device_snapshot_1.jpeg b/docs/images/build_device_snapshot_1.jpeg
diff --git a/docs/images/build_device_snapshot_2.png b/docs/images/build_device_snapshot_2.png
diff --git a/docs/images/build_device_snapshot_3.jpeg b/docs/images/build_device_snapshot_3.jpeg
diff --git a/docs/images/build_device_snapshot_4.jpeg b/docs/images/build_device_snapshot_4.jpeg
diff --git a/docs/images/build_device_snapshot_5.jpeg b/docs/images/build_device_snapshot_5.jpeg
diff --git a/docs/index.md b/docs/index.md
@@ -65,4 +65,4 @@ Folder "AppWithWearableReactNative": Wearable-connected version of the app that
 
 
 
-[Getting Started →](https://basedhardware.github.io/Friend/get_started/Setup/){: .btn .btn-purple }
+[Next Step: Getting Started →](https://basedhardware.github.io/Friend/get_started/Setup/){: .btn .btn-purple }