/vrc-osc-miband-hrm

Mi Band/Amazfit heart rate monitor with OSC integration for VRChat

Primary LanguageJavaScriptMIT LicenseMIT

Mi Band/Amazfit OSC heart rate monitor for VRChat

image
By Vard

What is this?

This app allows you to send OSC messages of your heart rate using your smartwatch/fitness tracker to your VRChat Avatar/Chatbox.
Basically you have 3 parameters to play with:

  • Heartrate sends float value from -1 to 1 (0-255bpm) (Use this when you need to display bpm counter)
  • Heartrate2 sends float value from 0 to 1 (0-255bpm) (Easier to control your animations but not enough precise over network. Do not use this to display bpm counter. Use cases: making actual sound of heartbeat, making animations which speed is equal to your bpm)
  • Heartrate3 sends int value from 0 to 255 (0-255bpm) (Useful for those who wanna bind specific event to specific heart rate. Use case: changing your outfit on avatar to sport one when your bpm goes higher than 130)

Supported devices

It was recently discovered that the app can support not only Mi band 4/5, but many more devices! If your smartwatch/fitness tracker supports Amazfit or Zepp apps, give it a try.

Confirmed devices list:

  • Xiaomi Mi Band 4/5/6
  • Amazfit Band 5/Bip S Lite

Requirements

  1. PC on Windows with Bluetooth 4.0 or higher
  2. Browser that supports Web Bluetooth API (Like Chrome)

Usage

  1. First and most complicated step is to get auth key of your device. (For more information - please visit https://freemyband.com/ or https://github.com/argrento/huami-token if you experienced with python)
  2. Download and launch vrc-osc-hrm.exe or if you don't trust me - Download this repository and run it trough node-js
  3. Enter your auth key and click Connect (Make sure you turned off bluetooth on your phone)
  4. Pair your smartwatch/fitness tracker with browser
  5. Wait about ~15s and done! Now you sending data about your heart rate to VRChat (Don't forget to turn on OSC in Action menu)

Example Avatar

As some of you asked - I made Example_Avatar.unitypackage (which is also requires RED_SIM's Simple counter shader) to show how Heartrate parameter works on avatar side.

If you have any questions: ask them here, or in #avatars-osc channel in VRChat discord.