Skip to content

Commit b331564

Browse files
committed
Update setup steps for v2
1 parent 50c04e6 commit b331564

File tree

1 file changed

+20
-31
lines changed

1 file changed

+20
-31
lines changed

README.md

Lines changed: 20 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,36 +19,22 @@ Either of which must be capable of handling at least Bluetooth version 4.0 (whic
1919

2020
### Setup steps
2121

22-
1. Find the latest release on the [Releases] page
23-
2. Download the attached DLL
24-
3. Place the DLL in `%appdata%\VRCOSC\assemblies`
25-
4. Start VRCOSC
26-
5. Scroll to the bottom of the module list
27-
6. Enable "Bluetooth Heartrate" (by clicking on the blank square in front of it)
28-
7. Turn on your heartrate monitor (if it has no separate power button, then simply put in on)
29-
8. Switch to the "Run" screen (play icon) and press the green play button to start the modules
30-
9. Wait for the module to discover your device. You should see log messages like the one below:
31-
32-
> \[Bluetooth Heartrate]: Discovered device: Polar H10 (MAC: XX:XX:XX:XX:XX:XX)
33-
34-
10. Once you see your device, click the blue button in the top right of the log window to open the log in Notepad
35-
11. Copy the MAC address of the device from the log file (only the `XX:XX:XX:XX:XX:XX` part)
36-
12. Return to VRCOSC and switch back to the module list
37-
13. Find the "Bluetooth Heartrate" module agan
38-
14. Click the cogwheel at the end of the module's line to access its settings
39-
15. Paste the MAC address into the "Device MAC address" setting input
40-
16. Switch back to the "Run" screen and check the log output
41-
42-
If everything went well, you should see the following messages:
43-
44-
> \[Bluetooth Heartrate]: Starting<br>
45-
> \[Bluetooth Heartrate]: Watching for devices<br>
46-
> \[Bluetooth Heartrate]: Started<br>
47-
> \[Bluetooth Heartrate]: Found device for MAC XX:XX:XX:XX:XX:XX<br>
48-
> \[Bluetooth Heartrate]: Found heartrate service<br>
49-
> \[Bluetooth Heartrate]: Found heartrate measurement characteristic<br>
50-
> \[Bluetooth Heartrate]: Requesting characteristic notifications<br>
51-
> \[Bluetooth Heartrate]: Connection successful
22+
1. Start VRCOSC and go to the Download page (1st icon from the top)
23+
2. Find "Bluetooth Heartrate" in the list
24+
3. Click the dropdown that says "Not Installed", select the latest available version (starts with "v2")
25+
4. Go to the Modules page (2nd icon from the top)
26+
5. Enable "Bluetooth Heartrate" (by clicking on the blank square in front of it)
27+
5. Turn on your heartrate monitor (if it has no separate power button, then simply put in on)
28+
6. Switch to the Run page (4th "play" icon) and press the green play button to start the modules
29+
7. Wait for the module to discover your device. You should see a dropdown appear in the runtime view showing your connected devices
30+
10. Once you see your device in the list, click its name
31+
11. The module will automatically start connecting
32+
33+
If everything went well, you should see the following log messages:
34+
35+
> \[Bluetooth Heartrate]: Selected device with MAC AB:CD:EF:01:23:45<br>
36+
> \[Bluetooth Heartrate]: Connection successful<br>
37+
> \[Bluetooth Heartrate]: Stopped scanning for devices
5238
5339
[Releases]: https://github.com/DJDavid98/VRCOSC-BluetoothHeartrate/releases
5440

@@ -66,9 +52,12 @@ As for the port, you can choose any number that is not already in use on the sys
6652

6753
### Known issues
6854

69-
Sometimes Windows' Bluetooth API starts being weird and you will see a "No heartrate characteristic found" in the logs.
55+
Sometimes Windows' Bluetooth API starts being weird, and you will see a "No heartrate characteristic found" in the logs.
7056
This can happen either temporarily (and the module might recover on its own after a few seconds) or it can be a persistent issue.
7157

58+
If the device cannot be connected to, the device name shown on the dropdown will blink blue/yellow.
59+
When this happens, try the steps below.
60+
7261
### Troubleshooting
7362

7463
If something went wrong, try:

0 commit comments

Comments
 (0)