Merge pull request #92 from Project-Babble/main

Baballonia release

Author: SummerSigh

docs/babbleofficaltracker/babbleofficaltracker.mdx

@@ -7,46 +7,86 @@ title: Babble Tracker Quickstart
 
 This guide applies to the Official Babble Tracker, and should cover DIY versions that use similar hardware/firmware. It will walk you through the complete setup process, from initial connection to calibration and troubleshooting.
 
+
+:::info
+If you'd like to use your tracker in *Wireless* mode, follow this [guide.](docs/babbleofficaltracker/babbleofficaltrackerwireless.mdx)
+:::
 ## Getting Started
-### Initial Setup
+### Hardware Setup
 
-1. **Plug your tracker into your PC**
-- Connect using the USB port on your tracker
-- Make sure the switch is in the "ON" position, as seen below
-- Two bright green lights should appear on the back of the tracker
-- You should hear a connection sound when properly connected
+**Plug your tracker into your PC**
+1) Connect using the USB port on your tracker
+1) Make sure the switch is in the "ON" position, as seen below
+1) A bright green lights should appear on the back of the tracker
+1) You should hear a connection sound when properly connected
+1) The tracker will take about 20 seconds to boot upon receiving power
 
 ![Switch Position](/img/setup_switch.jpg)
 
-2. **Finding your device's name**
-- **Windows**
-    - Press the Windows key, type "Device Manager" and press enter
-    - Expand "Ports (COM & LPT)"
-    - Look for a "USB Serial Device" entry - this is your tracker's COM port
+### Software Setup
+#### Windows
+    - Get the latest version from our [Github](https://github.com/Project-Babble/Baballonia/releases/latest). Download the installer and run it.
+#### macOS/Linux
+    - Currently, we do not offer installers for these platforms. You will need to build these from source.
+    - For assistance building Babble Avalonia on these platforms, please contact us in our discord server.
+    - Our [Legacy App](docs\software\babbleApps\babble-app.mdx) can be run from our [installer scripts](https://github.com/project-Babble/projectBabble/?tab=readme-ov-file#macos-and-linux) on the Github
+
+
+### Mode Selection
+
+:::info
+For more detailed instructions and troubleshooting information, head to the [firmware guide.](/hardware/Firmware/firmware.mdx)
+:::
+
+
+Now that you've got your Babble Tracker, you'll need to flash the firmware for it.
+
+#### Step 1 - Open Baballonia and navigate to the Firmware page:
+
+#### Step 1.1 - Plug in *or* unplug and replug your tracker to make sure it's in configuration mode.
+
+![fw](@site\static\img\avalonia\firmware\new\fw.png)
+
+#### Step 2 - Refresh the connected trackers. Then, select yours:
+
+:::warning
+Upon connecting the tracker, you will have a 20 second window to press ‘Refresh’. If you wait too long, you will need to unplug the tracker and try again.
+:::
+
+![refresh](@site\static\img\avalonia\firmware\new\refresh.png)
+![dropdown](@site\static\img\avalonia\firmware\new\dropdown.png)
+![selected](@site\static\img\avalonia\firmware\new\selected.png)
+
+#### Step 3 - Set your tracker into 'Wired' mode:
+
+![mode](@site\static\img\avalonia\firmware\new\mode.png)
+
 
-![Device Manager](/img/setup_comm.png)
+![wifi](@site\static\img\avalonia\firmware\new\wifi.png)
 
-- **macOS/Linux**
-    - On **macOS/Linux**, the Babble Tracker with appear as a device with a `/dev/ttyACM` prefix . You can list what devices are present with `ls -ld /dev/ttyACM*`.
+#### Step 4 Unplug and replug your tracker. 20 seconds after being powered on, it will start!
 
-#### Download and install the software
-- **Windows**
-    - Get the latest version from here [Babble Tracker Software](https://drive.google.com/file/d/1KmMBYSmAGlqDeTEjgnOOCX8YpWeeBgPb/view?usp=drive_link). Download the Project_Babble-Setup-vX.X.X.exe file and run the installer
-- **macOS/Linux**
-    - Use the [installer scripts](https://github.com/project-Babble/projectBabble/?tab=readme-ov-file#macos-and-linux) on the Github
+:::info
+The tracker will now boot into UVC mode and function as a USB camera with the device name 'openiristracker'
+:::
 
-#### Connect to your tracker
-- Open the Project Babble software
-- Click on the dropdown next to "Camera Address"
-- Select the namely identified in step 2
-- Click "Save and Restart Tracking" to connect
 
+### Connect to your tracker
+- Open Baballonia
+- Open the dropdown menu
+- Select 'openiristracker' 
 :::info
-If your camera isn't present in the dropdown, just type it in.
+Older trackers and DIY solutions running serial firmware will be start with `COM`/`/dev/ttyACM` followed by a number
 :::
+- Click "Start Camera" to connect
 
-![Camera Address Selection](/img/setup_dropdown_comm_select.png)
+ ![Camera Address Selection](/img/uvcfirst.png)
 
+ ![Camera Address Selection](/img/uvcsecond.png)
+
+ ![Camera Address Selection](/img/uvcthird.png)
+ 
+ ![Camera Address Selection](/img/uvclast.png)
 ## Setting Up The Camera Feed
 
 Before use, you need to properly set up your camera feed:
@@ -57,124 +97,44 @@ Before use, you need to properly set up your camera feed:
 - Positioned at a slight angle that shows the tip of your nose/nostrils
 
 2. **Set the crop area**
-- Click the "Cropping Mode" button
+- Set the Face Camera into "Cropping" mode
 
-![Cropping Mode Button](/img/babbleofficaltracker/1.png)
+![Cropping Mode Button](/img/crop1.png)
 
-- The feed may appear choppy in this mode - *this is normal*
 - Click and drag across the image to set the crop area
+
+   
+![Cropping Mode Button](/img/crop2.png)
+
 - Make sure the cropped area includes:
     - Tip of your nose/nostrils
     - Bottom of your jaw when open
     - Sides of your cheeks when puffed
 
 ![Proper Crop Example](/img/babbleofficaltracker/2.png)
 
-- Don't worry if the image is flipped - mirroring options are available at the bottom of the cam tab
+- Don't worry if the image is flipped - mirroring options are available in the "Face Camera Settings" dropdown
 
-3. **Switch to tracking mode**
-- Once you've set your crop, click "Tracking Mode"
-   
-![Tracking Mode Button](/img/babbleofficaltracker/3.png)
-   
-- You should now see a smooth video feed from your camera
-   
-![Working Camera Feed](/img/setup_working_V.png)
+![Face Camera Settings](/img/facecam.png)
 
-## Calibration Process
+![Face Camera Settings](/img/avaloniaface.png)
 
-Proper calibration is essential for accurate facial tracking:
+3. **Switch to tracking mode**
+- Once you've set your crop, set your face camera back into "Tracking"
 
-1. **Navigate to the Calibration tab**
 
-![Calibration Tab](/img/babbleofficaltracker/4.png)
-
-2. **Perform Neutral Calibration**
-- Set the calibration mode to "Neutral"
-
-![Neutral Mode](/img/babbleofficaltracker/5.png)
-
-- Return to the Cam tab
-- Check "Enable Calibration"
-
-![Enable Calibration](/img/babbleofficaltracker/8.png)
-
-- Relax your face into its natural resting position
-- Click "Start Calibration"
-
-![Start Calibration](/img/babbleofficaltracker/9.png)
-
-- You'll hear a sound indicating calibration has started
-- After a few seconds, click "Stop Calibration"
-
-![Stop Calibration](/img/babbleofficaltracker/10.png)
-
-3. **Perform Full Calibration**
-- Return to the Calibration tab
-- Set the calibration mode to "Full"
-
-![Full Mode](/img/babbleofficaltracker/6.png)
-
-- Go back to the Cam tab
-- Click "Start Calibration"
-- After hearing the start sound, make as many facial expressions as possible:
-    - Smile, frown, open mouth wide
-    - Puff cheeks, stick out tongue
-    - Move jaw side to side
-- **Tip:** Keep movements natural - don't exaggerate expressions
-- Calibration ends when you hear a different sound
-
-## Fine-Tuning and Troubleshooting
-
-If some expressions work better on one side than the other, or you need to adjust tracking sensitivity:
-
-### Understanding the Calibration Tab
-
-![Calibration Panel](/img/babbleofficaltracker/12.png)
-
-The calibration panel allows you to manually adjust tracking values:
-
-- **Left/Right**: Indicates which side of the face the shape corresponds to
-
-![Left Right Options](/img/babbleofficaltracker/13.png)
-
-- **Shapes**: The specific facial movement (left and/or right) being tracked (Mouth Open, Cheek Puff, etc.)
-
-![Shape Names](/img/babbleofficaltracker/14.png)
-
-- **Min**: The threshold at which the model starts detecting a shape
-
-![Min Value](/img/babbleofficaltracker/15.png)
-
-- **Max**: The maximum value the model detects for the shape
-
-![Maximum Value](/img/babbleofficaltracker/16.png)
-
-### Adjusting Values
-
-- For proper tracking, minimum values should generally start at around 0.1
-- Example with CheekPuff:
-  - Setting Minimum to 0.4: You need significant cheek puffing before detection
-  - Setting Maximum to 0.1: Slight cheek movement registers as full puffing
-
-### Fixing Common Issues
-
-If your jaw appears to lean in your neutral position:
-- Adjust the minimum value for JawLeft until it's no longer detected when your face is at rest
-
-**Pro Tip:** For precise adjustments, open your VR application's debug menu for the mouth tracking asset. Watch how values change as you make expressions, then return to the calibration tab to fine-tune.
-
-![Maximum Value](/img/babbleofficaltracker/17.png)
+- You should now see a smooth and cropped video feed from your camera
+   
+![Working Camera Feed](/img/crop3.png)
 
 ## Next Steps
 
-Your Babble Tracker is now set up and ready to use! To get started with specific VR platforms:
+To learn more about the Babble App, [click here.](/docs/software/baballonia.mdx)
+
+To get started with specific VR platforms:
 
 - [VRChat Integration Guide](docs/software/integrations/vrc.mdx)
 - [ChilloutVR Integration Guide](docs/software/integrations/chilloutVR.mdx)
 - [Resonite Integration Guide](docs/software/integrations/resonite.mdx)
 - [Other Platforms](docs/software/integrations/integrations.mdx)
 
-## WiFi Capability
-
-Want to use your tracker wirelessly? Check out our [Firmware Guide](docs/hardware/Firmware/firmware.mdx) for instructions on enabling and configuring WiFi functionality.