Skip to content

Commit 674c76c

Browse files
Update SmolSlimeConfigurator Page
* Update SmolSlimeConfigurator.md * docs: PR Clean-up --------- Co-authored-by: ShineBrightMeow <[email protected]>
1 parent 6ccaea6 commit 674c76c

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

src/smol-slimes/firmware/SmolSlimeConfigurator.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,48 +6,50 @@ Github page: [SmolSlimeConfigurator](https://github.com/ICantMakeThings/SmolSlim
66

77
# Features
88

9-
- **Easy-to-use interface** — clean, modern, and simple to navigate.
9+
- **Easy-to-use interface** — clean, modern, simple to use, with helpful tooltips.
1010
- **Effortless configuration** — one-click buttons for calibration, pairing, and more.
11-
- **Helpful tooltips** — hover over any button to see what it does, perfect for beginners.
12-
- **Automatic firmware updater** — just plug your tracker in via USB, select your firmware type, and flash the latest build instantly.
11+
- **Automatic firmware updater** — plug your tracker in via USB, select your firmware type, and flash the latest build instantly.
1312
- **Always up to date** — the firmware list automatically fetches the latest daily builds from GitHub.
14-
- **Custom firmware support** — flash your own `.uf2` file with a single click.
15-
- **Favorites system** — star your most-used firmware versions by right-clicking.
13+
- **Custom firmware support** — flash your own `.uf2` or `.hex` files with ease (now supports all dongles and trackers).
14+
- **Favorites system** — star your most-used firmware versions by right-clicking (middle-click on macOS).
1615
- **Cross-platform** — available for **Windows**, **Linux**, **macOS**, and **Android**.
1716
- **Theme customization** — switch between **light/dark mode** and choose your favorite accent color.
1817

18+
1919
# Download
20-
There are 2 options to run the Configurator:
20+
There are two options to run the Configurator:
2121
- Single-file executables are available from [Releases](https://github.com/ICantMakeThings/SmolSlimeConfigurator/releases) (Windows, Linux, macOS, Android).
2222
- Python file from the uploaded files above.
2323
- To build it from source, run:
2424
```bash
25-
pyinstaller --onefile --windowed --icon=icon.png --add-data "icon.png:." SmolSlimeConfiguratorVx.py
25+
pyinstaller --onefile --windowed --icon=icon.png --add-data "icon.png:." --add-binary "/Location/To/UR/NameOfVenv/bin/nrfutil:." SmolSlimeConfiguratorV8.py
2626
```
27+
*Note: You **must** use a virtual environment, **must** use Python 3.10.x, and change the icon file extension to `.icns` on macOS or `.ico` on Windows.*
28+
2729

2830
# Instructions
2931
**Note:** There is a [video tutorial](https://youtu.be/2PHelwy7Rcs) explaining general usage, and [this video](https://www.youtube.com/watch?v=ENINHh4L8tk) covers **Android usage** in detail.
3032

3133
### **First install**
3234

33-
+ Plug in the tracker or reciever, press reset twice, or on boards that dont have a button, hold one side of a wire on rst pin ![rst-pin](../assets/img/ect/NiceNano-RST.png)
34-
and double tap a gnd pin (The usbc connector on the Nice!Nano/ProMicro)![nicenano-usbc-header](../assets/img/ect/NiceNano-USBC.png)
35+
+ Plug in the tracker or receiver and press reset twice. On boards without a reset button, hold one side of a wire on the RST pin ![rst-pin](../assets/img/ect/NiceNano-RST.png)
36+
and double-tap a GND pin (the USB-C connector on the Nice!Nano/ProMicro) ![nicenano-usbc-header](../assets/img/ect/NiceNano-USBC.png)
3537
+ Press "↻" refresh, then select the port from the dropdown menu on the left of the refresh button, then press "Connect"
3638
+ Select the version of hardware from the dropdown menu called "Select Firmware", press "⬇ Firmware", Wait ~20 seconds, the tracker will flash.
3739

3840
### **Pairing**
39-
40-
+ Plug in your Reciever, press "↻" refresh and select the port And then press "Connect"
41-
+ To Configure your reciever, select the reciever tab, press pairing mode and power on each reciever one by one, you should notice ![image](../assets/img/ect/SerialSSC.png) the trackers being added, once all the trackers have been paired, press "Exit Pairing Mode"
41+
42+
+ Plug in your receiver, press "↻" refresh, select the port, then press "Connect".
43+
+ To configure your receiver, select the receiver tab, press pairing mode, and power on each receiver one by one. You should notice ![image](../assets/img/ect/SerialSSC.png) the trackers being added. Once all trackers have been paired, press "Exit Pairing Mode".
4244

4345
### **Calibration**
4446

45-
+ Plug in a tracker, Press "↻" refresh, select the COM port & "Connect", press "Calibrate 6 Sides", do what the terminal says.
46-
+ Then press "Calibrate", leave the tracker on a desk for 5~ seconds and done!
47-
**Note: You can also doubble tap the trackers button instead of pressing "Calibrate"**
47+
+ Plug in a tracker, press "↻" refresh, select the COM port, and press "Connect". Press "Calibrate 6 Sides" and follow the terminal instructions.
48+
+ Then press "Calibrate", leave the tracker on a desk for ~5 seconds, and you're done!
49+
**Note:** You can also double-tap the tracker's button instead of pressing "Calibrate".
4850

4951
### **Updating Firmware**
5052

5153
+ Connect to the port, select the firmware, press "⬇ Firmware" and wait ~20 seconds.
5254

53-
**Note: Trackers and recievers need to be all updated on the same version or they wont want to pair**
55+
**Note:** Trackers and receivers must all be updated to the same version, or they will not pair.

0 commit comments

Comments
 (0)