hds_overlay icon indicating copy to clipboard operation
hds_overlay copied to clipboard

This is a stream overlay that shows heart rate, calorie burn, and more information sent from an Apple Watch or Android watch running the Health Data Server app

Health Data Server Overlay

This is a stream overlay that shows heart rate, calorie burn, and more information sent from an Apple Watch or Android watch running the Health Data Server app

Setup Tutorial Video

Links

  • Web app (for use as a browser source)
    • If you use HDS Cloud all you need is this and the watch app
    • Heart rate is free forever with HDS Cloud (assuming you bought a watch app)
  • Apple Watch/iOS/macOS app
    • THE WATCHOS APP REQUIRES WATCHOS 6.2+. The App Store will let you purchase it even if your watch can't run watchOS 6.2+, so make sure before buying.
  • Android watch app
    • The Wear OS app currently works on Wear OS 2.0, but can only send heart rate. When Wear OS 3.0 releases on August 27, I will work on an update to send calories, step count, speed, and distance. Please note that this update will ONLY support Wear OS 3.0.
  • Windows app
  • Windows/macOS/linux executables

HDS in action

Preview Image

You can track development progress here

Set up with HDS Cloud

  1. Download the watch app for your device
  2. Add hds.dev as a browser source in OBS
  3. Input the HDS Cloud ID from the browser source into the overlay ids section on the watch
  4. (optional) Hold alt (Windows) or opt (macOS) and drag the edges of the browser source to crop it
  5. Click the start button on the watch
  6. It should just work
  7. To edit the overlay configuration right click on the browser source in the sources list and click Interact

Set up the old fashioned way

Heart rate is free forever with HDS Cloud. Unless you need more data than just heart rate and don't want to pay the subscription or do not have internet access this section is not for you.

  1. Download the watch app and the desktop app for your platform
  2. For the Windows Firewall prompt, make sure to check both the boxes and then click "Allow access"
    • Firewall Dialog
  3. Add hds.dev as a browser source in OBS
  4. Right click on the browser source in the sources section and click "Interact"
  5. Go into the settings and disable HDS Cloud
  6. Hold alt (Windows) or opt (macOS) and drag the edges of the browser source to crop it
  7. Make sure the watch and device running the overlay application are on the same network. If the watch is connected to a phone, you just need to make sure the phone is connected to the same network.
  8. Disable HDS Cloud in the settings on the watch
  9. Type the IP address of the machine running the overlay application
    • The overlay application will list possible IP addresses of your machine on startup. If none of those work, you may have to find the IP address manually.
    • If you need help finding the IP address of your machine, read this. It probably looks something like this: 192.168.xxx.xxx
    • If you want to send data to an external server, you will need to input the full websocket URL ex: ws://hostname:port/other/stuff
  10. Click the start button on the watch

Useful things

  • You can import a config with a url parameter. This is useful if you want to use something like the Streamlabs mobile app in which you cannot interact with the web page.
    1. Use hds.dev to create the overlay configuration you want
    2. Click the export button in the top right to copy the configuration to your clipboard
    3. Use https://www.urlencoder.org to encode the config that you just copied
    4. Create a url that looks like this: https://hds.dev/#/overlay?config=Encoded config
    5. Use that url as a browser source in your app of choice

If you have problems

Try these troubleshooting steps before asking for help

Please consider writing a review

Many people only leave reviews when they have a problem with an app. Even if many users don't have an issue, these negative reviews can turn off potential new users. If you enjoy this application, please consider leaving a review on the App Store page. Even a simple review helps a lot!