Skip to content

Commit 5b6285b

Browse files
authored
Merge pull request #109 from Project-Babble/main
Bring updates from main to development
2 parents 289428a + dc397d8 commit 5b6285b

File tree

15 files changed

+237
-229
lines changed

15 files changed

+237
-229
lines changed

docs/babbleofficaltracker/babbleofficaltracker.mdx

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
---
22
sidebar_position: 2
3-
title: Babble Tracker Quickstart
3+
title: Quickstart Guide
44
---
55

6+
import ImageGallery from '@site/src/components/ImageGallery/ImageGallery';
7+
68
# Babble Tracker Quickstart
79

810
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.
911

10-
1112
:::info
12-
If you'd like to use your tracker in *Wireless* mode, follow this [guide.](docs/babbleofficaltracker/babbleofficaltrackerwireless.mdx)
13+
If you'd like to use your tracker in _Wireless_ mode, follow this [guide](docs/babbleofficaltracker/babbleofficaltrackerwireless.mdx).
1314
:::
15+
1416
## Getting Started
1517
### Hardware Setup
1618

@@ -32,22 +34,20 @@ If you'd like to use your tracker in *Wireless* mode, follow this [guide.](docs/
3234
- Our [Legacy App](docs\babbleofficaltracker\legacySetup.mdx) can be run from our [installer scripts](https://github.com/project-Babble/projectBabble/?tab=readme-ov-file#macos-and-linux) on the Github
3335

3436

35-
### Mode Selection
37+
### Tracker Mode Selection (Wired or Wireless)
3638

3739
:::info
3840
For more detailed instructions and troubleshooting information, head to the [firmware guide.](/hardware/Firmware/firmware.mdx)
3941
:::
4042

41-
4243
Now that you've got your Babble Tracker, you'll need to flash the firmware for it.
4344

44-
#### Step 1 - Open Baballonia and navigate to the Firmware page:
45-
46-
#### Step 1.1 - Plug in *or* unplug and replug your tracker to make sure it's in configuration mode.
45+
1) Open Baballonia and navigate to the Firmware page:
46+
2) Plug in *or* unplug and replug your tracker to make sure it's in configuration mode.
4747

4848
![fw](@site\static\img\avalonia\firmware\new\fw.png)
4949

50-
#### Step 2 - Refresh the connected trackers. Then, select yours:
50+
3) Refresh the connected trackers. Then, select yours:
5151

5252
:::warning
5353
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.
@@ -57,37 +57,41 @@ Upon connecting the tracker, you will have a 20 second window to press ‘Refres
5757
![dropdown](@site\static\img\avalonia\firmware\new\dropdown.png)
5858
![selected](@site\static\img\avalonia\firmware\new\selected.png)
5959

60-
#### Step 3 - Set your tracker into 'Wired' mode:
60+
4) Set your tracker into 'Wired' mode:
6161

6262
![mode](@site\static\img\avalonia\firmware\new\mode.png)
6363

64-
:::info
65-
You do not need to utilize the firmware flashing feature after changing mode
64+
:::danger
65+
Do not click the "flash firmware" buttons after changing the mode! If you do you'll need to start over.
6666
:::
6767

68-
#### Step 4 Unplug and replug your tracker. 20 seconds after being powered on, it will start!
68+
5) Unplug and replug your tracker. 20 seconds after being powered on, it will start!
6969

7070
:::info
7171
The tracker will now boot into UVC mode and function as a USB camera with the device name 'openiristracker'
7272
:::
7373

74-
7574
### Connect to your tracker
76-
- Open Baballonia
77-
- Open the dropdown menu
78-
- Select 'openiristracker'
75+
1) Open Baballonia
76+
1) Open the dropdown menu
77+
1) Select 'openiristracker'
78+
1) Click "Start Camera" to connect
79+
80+
<ImageGallery images={[
81+
"/img/uvcfirst.png",
82+
"/img/uvcsecond.png",
83+
"/img/uvcthird.png",
84+
"/img/uvclast.png",
85+
]} />
86+
7987
:::info
8088
Older trackers and DIY solutions running serial firmware will be start with `COM`/`/dev/ttyACM` followed by a number
8189
:::
82-
- Click "Start Camera" to connect
83-
84-
![Camera Address Selection](/img/uvcfirst.png)
8590

86-
![Camera Address Selection](/img/uvcsecond.png)
91+
:::info
92+
In the event your tracker does not show up in the dropdown, you can enter a numerical index for a camera (0, 1, 2...);
93+
:::
8794

88-
![Camera Address Selection](/img/uvcthird.png)
89-
90-
![Camera Address Selection](/img/uvclast.png)
9195
## Setting Up The Camera Feed
9296

9397
Before use, you need to properly set up your camera feed:
@@ -103,7 +107,6 @@ Before use, you need to properly set up your camera feed:
103107
![Cropping Mode Button](/img/crop1.png)
104108

105109
- Click and drag across the image to set the crop area
106-
107110

108111
![Cropping Mode Button](/img/crop2.png)
109112

@@ -121,9 +124,7 @@ Before use, you need to properly set up your camera feed:
121124
![Face Camera Settings](/img/avaloniaface.png)
122125

123126
3. **Switch to tracking mode**
124-
- Once you've set your crop, set your face camera back into "Tracking"
125-
126-
127+
- Once you've set your crop, set your face camera back into "Tracking"
127128
- You should now see a smooth and cropped video feed from your camera
128129

129130
![Working Camera Feed](/img/crop3.png)

docs/babbleofficaltracker/babbleofficaltrackerwireless.mdx

Lines changed: 26 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,11 @@ sidebar_position: 2
33
title: Wireless Setup
44
---
55

6-
# Wireless Mode Quickstart
7-
8-
9-
6+
import ImageGallery from '@site/src/components/ImageGallery/ImageGallery';
107

8+
# Wireless Mode Quickstart
119

12-
## Getting Started
13-
### Hardware Setup
10+
## Hardware Setup
1411

1512
**Plug your tracker into your PC**
1613
1) Connect using the USB port on your tracker
@@ -21,16 +18,15 @@ title: Wireless Setup
2118

2219
![Switch Position](/img/setup_switch.jpg)
2320

24-
### Software Setup
25-
#### Windows
21+
## Software Setup
22+
### Windows
2623
- Get the latest version from our [Github](https://github.com/Project-Babble/Baballonia/releases/latest). Download the installer and run it.
27-
#### macOS/Linux
24+
### macOS/Linux
2825
- Currently, we do not offer installers for these platforms. You will need to build these from source.
2926
- For assistance building Babble Avalonia on these platforms, please contact us in our discord server.
3027
- 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
3128

32-
33-
### Mode Selection
29+
## Mode Selection
3430

3531
:::warning
3632
Your MUST have 2.4Ghz Wifi network for a Babble Tracker or any ESP32 device to connect wirelessly.
@@ -43,14 +39,11 @@ For more detailed instructions and troubleshooting information, head to the [fir
4339

4440
Now that you've got your Babble Tracker, you'll need to flash the firmware for it.
4541

46-
47-
#### Step 1 - Open Baballonia and navigate to the Firmware page:
48-
49-
#### Step 1.1 - Plug in *or* unplug and replug your tracker to make sure it's in configuration mode.
42+
1) Open Baballonia and navigate to the Firmware page. Plug in *or* unplug and replug your tracker to make sure it's in configuration mode.
5043

5144
![fw](@site\static\img\avalonia\firmware\new\fw.png)
5245

53-
#### Step 2 - Refresh the connected trackers. Then, select yours:
46+
2) Refresh the connected trackers. Then, select yours:
5447

5548
:::warning
5649
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.
@@ -60,41 +53,40 @@ Upon connecting the tracker, you will have a 20 second window to press ‘Refres
6053
![dropdown](@site\static\img\avalonia\firmware\new\dropdown.png)
6154
![selected](@site\static\img\avalonia\firmware\new\selected.png)
6255

63-
#### Step 3 - Set the tracker into 'Wireless' mode:
56+
3) Set the tracker into 'Wireless' mode:
6457

6558
![mode](@site\static\img\avalonia\firmware\new\mode.png)
6659

67-
:::info
68-
You do not need to utilize the firmware flashing feature after changing mode
60+
:::danger
61+
Do not click the "flash firmware" buttons after changing the mode! If you do you'll need to start over.
6962
:::
7063

71-
#### Step 3.1 - Set your Wifi credentials:
64+
4) Set your Wifi credentials:
7265

7366
:::warning
7467
You need to press 'Refresh Wifi Networks' before the tracker can connect to a network, even if you enter the SSID manually.
7568
:::
7669

7770
![wifi](@site\static\img\avalonia\firmware\new\wifi.png)
7871

79-
#### Step 4 Unplug and replug your tracker. 20 seconds after being powered on, it will start!
72+
5) Unplug and replug your tracker. 20 seconds after being powered on, it will start!
8073

8174
:::info
8275
The tracker will now boot into Wireless mode and function as a wireless camera broadcasting on the URL 'http://openiristracker.local/'
8376
:::
8477

85-
### Connect to your tracker
86-
- Open Baballonia
87-
- Type in the URL of the wireless tracker
88-
- The default will be 'http://openiristracker.local/'
89-
- Click "Start Camera" to connect
90-
91-
![Camera Address Selection](/img/wire1.png)
92-
93-
![Camera Address Selection](/img/wire2.png)
94-
95-
![Camera Address Selection](/img/wire3.png)
96-
97-
![Camera Address Selection](/img/wir4.png)
78+
## Connect to your tracker
79+
1) Open Baballonia
80+
2) Type in the URL of the wireless tracker
81+
3) The default will be 'http://openiristracker.local/'
82+
4) Click "Start Camera" to connect
83+
84+
<ImageGallery images={[
85+
"/img/wire1.png",
86+
"/img/wire2.png",
87+
"/img/wire3.png",
88+
"/img/wir4.png",
89+
]} />
9890

9991
## Setting Up The Camera Feed
10092

docs/babbleofficaltracker/legacySetup.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ title: Legacy App Instructions
55

66
# Legacy App Instructions
77

8-
This guide applies to the Official Babble Tracker (and DIY versions with similar hardware/firmware) **with the Legacy App**. The first half of instructions here are the same as Baballonia.
8+
:::warning
9+
This page concerns the [legacy Desktop App](/docs/software/sourceCode/python.mdx), which is no longer updated. For current babbling, please use the current Desktop App [Baballonia](docs/software/baballonia.mdx).
10+
:::
911

1012
## Getting Started
1113
### Initial Setup
1214

13-
1. **Plug your tracker into your PC**
15+
1. Plug your tracker into your PC
1416
- Connect using the USB port on your tracker
1517
- Make sure the switch is in the "ON" position, as seen below
1618
- Two bright green lights should appear on the back of the tracker
@@ -42,7 +44,7 @@ This guide applies to the Official Babble Tracker (and DIY versions with similar
4244
- Click "Save and Restart Tracking" to connect
4345

4446
:::info
45-
If your camera isn't present in the dropdown, just type it in.
47+
If your camera isn't present in the dropdown, just type it in its numerical index (0, 1, 2...)
4648
:::
4749

4850
![Camera Address Selection](/img/setup_dropdown_comm_select.png)

docs/software/baballonia.mdx

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)