Smol Pairing & Calibration
Firmware Setup
Accessing the Serial Console
You can interact with the firmware by connecting to the serial console it provides, which is used for pairing and calibration.
The following examples will utilize nRF Connect for Desktop; however, you may choose from a wide variety of alternative tools.
For example, by using the standard Linux screen
utility, you can access the serial console as follows:
sudo screen /dev/ttyACMX 115200
You can determine which serial port to use by running sudo dmesg
after connecting your nRF device.
For Windows, there are similar tools available, such as PuTTY that you can use to access a serial console.
Pairing Mode
Disclaimer: For trackers to appear on SlimeVR server for the first time it usually required to reboot receivers and trackers after pairing. Trackers appear in server list only after being moved.
Tracker
Method 1: Console
- Launch nRF Connect for Desktop.
- Open the Serial Terminal in nRF Connect.
- Ensure that your tracker is connected to your computer using a cable.
- In the top left corner, select your tracker from the Device menu.
- Click the "Connect to Port" button.
- Type
pair
into the console.
Method 2: Button
- Press the Reset button (or short RST/GND pins) or the Function button (if SW0 is defined) three times.
The device's LED should blink once every second.
Receiver
- Launch nRF Connect for Desktop.
- Open the Serial Terminal in nRF Connect.
- Ensure that your tracker is connected to your computer using a cable.
- In the top left corner, select your dongle from the Device menu.
- Click the "Connect to Port" button.
- Type
pair
into the console.
The device's LED should blink once every second.
Once the trackers are paired, the LED indicator should stop blinking once per second. To exit pairing mode on the Receiver, type reboot
in the console, or press the left button once on the eByte Dongle, or the round white button once on the Nordic Dongle.
Calibration
Basic
Method 1: Console
- Launch nRF Connect for Desktop.
- Open the Serial Terminal in nRF Connect.
- Ensure that your tracker is connected to your computer using a cable.
- In the top left corner, select your tracker under Devices.
- Click the "Connect to Port" button.
- Type
calibrate
into the console while the tracker is placed on a flat surface. - Wait for the logs to reboot and print out again.
Method 2: Button
- Press the Reset or SW0 (Functional) button twice, then place the tracker on a flat surface and allow it to remain still for a few seconds.
6-Sided
- Ensure that the power switch is turned on so that the tracker can operate on battery power when unplugged.
- Launch the nRF Connect for Desktop.
- Open the Serial Terminal in nRF Connect.
- Ensure that your tracker is connected to your computer using a cable.
- In the top left corner, select your tracker under Devices.
- Click the "Connect to Port" button.
- Enter the
6-side
command in the console. (Currently, there is no button combination available to initiate this calibration.) - Follow the console log while rotating the sides on a flat surface. Leave the cable side for last.
- When prompted for the final side, disconnect your USB cable and position the side with the USB port on a flat surface.
- Wait a moment until the calibration is complete.
Magnetometer
- Please note that this calibration is passively active and does not require any command or button press combination to initiate.
- Rotate your tracker 360 degrees on each of the six sides of the tracker while it is placed on a flat surface.
Note: The LED will blink when you place it flat on each side and will blink continuously when it is ready to save.
Updating Firmware
- If your receiver requires a firmware update, please do this first.
- Open the Serial Terminal in nRF Connect's Serial Terminal.
- Select your Receiver from the Device list.
- Click the "Connect to Port" button.
- Enter
clear
to unpair all of your trackers from the Receiver. The Receiver will automatically enter pairing mode. - Connect the tracker to your computer using a USB cable and ensure that the power switch is turned on. This allows the tracker to operate on battery power when unplugged for 6-Side calibration.
- Select your tracker from the Device List.
- Click the "Connect to Port" button.
- Enter
dfu
to go into DFU Mode. - Copy the UF2 file to your tracker.
- Enter
6-side
to begin the 6-Side calibration. - After completing the 6-side calibration, enter
calibrate
to adjust the ZRO. - Enter
pair
to enter pairing mode. - Wait for the tracker to pair with the Receiver, and then disconnect.
- Please repeat process for all trackers.
- Select your Receiver from the Device list.
- Click the "Connect to Port" button.
- Enter
reboot
to exit pairing mode.
Console Commands
Receiver
info
- Get device informationlist
- Get paired devicesreboot
- Soft reset the devicepair
- Enter pairing modeclear
- Clear stored devicesdfu
- Enter DFU bootloader (only available if your device has one)uptime
- Get device uptimemeow
- Meow!
Tracker
info
- Get device informationreboot
- Soft reset the devicecalibrate
- Calibrate sensor ZRO6-side
- Calibrate 6-side accelerometerpair
- Enter pairing modedfu
- Enter DFU bootloader (only available if your device has one)uptime
- Get device uptimemeow
- Meow!
Button
- Reset - 1 Press
- Calibration - 2 Presses
- Pairing Mode - 3 Presses
- DFU Bootloader - 4 Presses
- Deep Sleep - Press and Hold
LED Codes
- 1 short blink per second - Pairing mode.
- 1 long blink per second - Low battery.
- 2, 3, 4 long blinks every 5 seconds - Error.
- 2 blinks - Sensor error.
- 3 blinks - Connection error.
- 4 blinks - Hardware error.
- Fade on and off - DFU mode.
- Very short blink - Normal operation or wake on motion.
- While plugged in: Pulsing - Charging.
- While plugged in: Solid - Fully charged.
Status Codes
Status codes consist of one or more status values (added together) listed below:
- SYS_STATUS_SENSOR_ERROR - 1,
- SYS_STATUS_CONNECTION_ERROR - 2
- SYS_STATUS_SYSTEM_ERROR - 4
- SYS_STATUS_USB_CONNECTED - 8
- SYS_STATUS_PLUGGED - 16