|
1 | 1 | # Smol Slime
|
2 | 2 | ```admonish warning
|
3 |
| -**Disclaimer:** This project is highly experimental. These devices may be incompatible with newer versions of the SlimeVR Server and may require frequent firmware updates. Nothing is final at this stage, including hardware, firmware, and communication protocols. |
| 3 | +**Disclaimer:** This project is highly experimental. These devices may be incompatible with newer versions of the SlimeVR Server and could require frequent firmware updates. Nothing is final at this stage, including hardware, firmware, and communication protocols. |
4 | 4 | ```
|
5 | 5 |
|
6 |
| -Smol Slimes, also known as nRF Trackers, use a protocol called Enhanced ShockBurst (ESB) on Nordic Semiconductor's nRF52 and nRF54L series System-on-Chip (SoC) devices. These trackers are highly power-efficient and require only a small battery, often lasting for days or even weeks—significantly longer than traditional ESP (WiFi-based) SlimeVR trackers. A receiver (or dongle) is needed to bridge communication between the trackers and the SlimeVR Server. Note: This setup does not work with standalone Quest headsets unless you use a computer with OSC (Open Sound Control). |
| 6 | +Smol Slimes, also known as nRF Trackers, use a protocol called Enhanced ShockBurst (ESB), on Nordic Semiconductor's nRF52 and nRF54L series System-on-Chip (SoC) devices. These trackers are highly power-efficient and require only a small battery, often lasting for days or even weeks—significantly longer than traditional ESP (WiFi-based) SlimeVR trackers. A receiver (or dongle) is needed to bridge communication between the trackers and the SlimeVR Server. This setup does not work with standalone Quest headsets unless OSC (Open Sound Control) is used via a connected computer. |
7 | 7 |
|
8 |
| -```admonish note |
9 |
| -Welcome, traveler. If you're new, check out the [Smol Community Builds](community/smol-slimes-community-builds.md) for completed project examples and suggested parts. |
| 8 | +## Getting Started |
10 | 9 |
|
11 |
| -You can explore [Smol Receiver](hardware/smol-receiver.md) and [Smol Tracker](hardware/smol-tracker.md) to learn more. |
| 10 | +- **[Community Builds](community/smol-slimes-community-builds.md)** |
| 11 | + Examples of completed builds, cases, and lists of components you will need to create your own set of matching trackers. |
12 | 12 |
|
13 |
| -Community designs will usually work with a pre-built firmware. |
14 |
| -- You can find pre-built firmware in the [Pre-Compiled Firmware](firmware/smol-pre-compiled-firmware.md) section. |
15 |
| -- To build the firmware yourself, see [Compiling Firmware](firmware/smol-compiling-firmware.md). |
| 13 | +- **[Hardware](hardware/index.md)** |
| 14 | + Guides on hardware used for trackers and receiver, schematics for assembly, and cost calculator for planning out your project. |
16 | 15 |
|
17 |
| -Once you’ve flashed the firmware, you’ll need to set up and calibrate it—see [Smol Pairing & Calibration](firmware/smol-pairing-and-calibration.md). |
18 |
| -``` |
| 16 | +- **[Firmware](firmware/index.md)** |
| 17 | + Guides on using pre-compiled firmware, configuring and compiling your own firmware, and flashing firmware for your devices. |
| 18 | + |
| 19 | +- **[Pairing & Calibration](firmware/smol-pairing-and-calibration.md)** |
| 20 | + Guides on pairing your trackers to your receiver, performing various calibrations for your trackers, lists of console commands, and button press functions. |
19 | 21 |
|
20 |
| -Interested, have questions, or running into issues? Chat with us in ***#diy-smol*** on the <a href="https://discord.gg/SlimeVR" target="_blank">SlimeVR Discord</a>! |
| 22 | +Are you interested, have questions, or running into issues? Chat with us in ***#diy-smol*** on the <a href="https://discord.gg/SlimeVR" target="_blank">SlimeVR Discord</a>! |
21 | 23 |
|
22 | 24 | <hr/>
|
23 | 25 |
|
|
0 commit comments