-
Notifications
You must be signed in to change notification settings - Fork 1
Setup
An entire guide on how to setup FitbitHRtoWS for version 1.4.0 and above
Because of Fitbit's App, there is a low success rate of getting a local server running properly. Please consider using Public Servers as they have a very low failure rate (meaning it will probably work)
If you choose to use Public Servers, please skip past the Server section of this guide and start at the Fitbit App portion.
This part of the setup is for setting up the server on the device which you'll be listening for the HeartRate information. This is tested for Windows x64, but should also work on Linux x64 and Mac via. Wine or Node (source code).
Head over to the Releases Page, and download the latest release. The file you're downloading should be called FitbitHRtoWS-Server.zip. This file includes builds for both Windows and Linux x64. If you have a device that does not have a build, please follow Legacy Documentation for the Server portion.
Next, extract the files to their own directory.
- DO NOT RUN THE FILES FROM WINRAR/7ZIP/ETC. BEFORE EXTRACTING!
- DO NOT MOVE ONLY THE EXE/SHELL FILE! YOU NEED
config.json!
With the files in there, you can open the config.json file to edit any values you may want.
| Config Key | Default Value | Description |
|---|---|---|
| httpport | (int)8000
|
Port that the WebServer listens to |
| wsport | (int)8080
|
Port that the WebSocket listens to |
| serverPassword | (string)CHANGEME
|
Password for the Fitbit Watch to enter in to be able to connect. |
After you've made all the changes you need to, save and close out of the config.
NOTE
You will need to Port Forward at least the WebSocket Port (TCP) for your watch to be able to connect! (locally) See the Port Forwarding Guide for more information.
For Windows:
Run the hrtows-windows-x64.exe executable.
For Linux:
- Open Terminal
- Navigate to the Directory that you extracted
- Run
./hrtows-linux-x64
The server should start in 5 seconds, and output what Ports it's listening on.
The app now has it's own spot on the Fitbit App Gallery, but it's set to private. All you need is the link and you should be able to install it.
To install the app, you must know which SDK your watch works with. Below is a Table of watches and what SDK they work with. (SDK6 excluded because there's no builds for it)
| Watch | SDK Type | Alias |
|---|---|---|
| Ionic | SDK4 | higgs |
| Versa | SDK4 | meson |
| Versa Lite | SDK4 | gemini |
| Versa 2 | SDK4 | mira |
| Versa 3 | SDK5 | atlas |
| Sense | SDK5 | vulcan |
Now, on your phone, navigate to the URL which matches your SDK version, and install the app to your watch.
SDK4: https://gallery.fitbit.com/details/d16ebb83-f52a-4fc3-9819-0447902a9d95
SDK5: https://gallery.fitbit.com/details/9cba4c69-c895-4ff1-b6a6-b0b52948fdcc
In your app settings, there will be a couple settings you can change. These are important because you will need some of these filled in to be able to connect to your WebSocket.
Here's a list of the settings:
| Setting Label | Default Value | Description |
|---|---|---|
| WS Uri | (string)null
|
The URI for the WebSocket you're connecting to. Example: ws://192.168.1.1:8080
|
| Server Password | (string)CHANGEME
|
The Password for the WebSocket Server. |
| Low Interval Update | (bool)false
|
Sends HR Updates at 500ms opposed to 1000ms. Recommended for local servers. |
- If you don't know how to find your computer's local IP address, see this article.
- Make sure the WebSocket address protocol is
ws(s)://and nothttp(s)://. - After saving settings, please wait at least 15 seconds before launching the FitbitHRtoWS app again. The companion needs time to update.
Once you have your settings saved, on your watch, navigate to the homepage and you will see the FitbitHRtoWS app. Open the app and the connection status should turn to Connected! You can also view these stats on the WebServer.
- Make sure you've Port Forwarded locally
- Make sure both your Server and App Config/Settings are the same
- Try the WebServer and see if the WebSocket can connect
- Make sure your Server Passwords are the same
If all that fails, open a discussion in Q&A.