https://github.com/horihiro/node-fitbit-livedata
This project aims to getting `livedata` from Fitbit tracker, is unofficial and experimental.
https://github.com/horihiro/node-fitbit-livedata
fitbit fitbit-tracker livedata node-fitbit-livedata nodejs
Last synced: 6 months ago
JSON representation
This project aims to getting `livedata` from Fitbit tracker, is unofficial and experimental.
- Host: GitHub
- URL: https://github.com/horihiro/node-fitbit-livedata
- Owner: horihiro
- License: mit
- Created: 2017-09-06T20:32:37.000Z (about 8 years ago)
- Default Branch: develop
- Last Pushed: 2017-12-19T06:42:29.000Z (almost 8 years ago)
- Last Synced: 2025-04-07T22:09:21.289Z (6 months ago)
- Topics: fitbit, fitbit-tracker, livedata, node-fitbit-livedata, nodejs
- Language: JavaScript
- Size: 2.66 MB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-fitbit-livedata
This project aims to getting `livedata` from Fitbit tracker
## !!! CAUTION !!!
This is an **UNOFFICIAL** and **EXPERIMENTAL** module.
Using this module sometimes forcibly logs out from fitbit application on your mobile device.
## Requirement
- Host Machine
- macOS El Capitan
- Windows10 Creators Update or later
- Raspbian 4.9
- Runtime
- node.js (v6 or later)
- Java (v1.8.0 or later)
- Fitbit Account
- Fitbit Tracker(Device) registered in the above account
- Supported Trackers are
- Charge HR
The following trackers are not supported yet.
- Ionic
The following trackers are not verified yet.
\# I don't have them
- Charge 2
- Alta HR
- Blaze
- Flyer
- Flex 2
- Surge
- Charge
- Flex
- One
- Zip
- Ultra
- Force
- Aria 2
## Remarks
### for Mac
Using this module on macOS, you need to connect or sync the macOS and your tracker with the [official application](https://www.fitbit.com/jp/setup?platform=mac10_5) **only once** before using this module.
### for Windows
Because of using [noble-uwp](https://github.com/jasongin/noble-uwp) (it's very useful !), the version of your windows has to be Creators Update or later.
And this module on Windows can't get heart rate from your trackers.
### for Raspbian
If you want to get heart rate from your trackers, you need to comment out [the line](https://github.com/sandeepmistry/bleno/blob/master/lib/hci-socket/bindings.js#L137) in `node_modules/bleno/lib/hci-socket/bindings.js` ([bleno's issue](https://github.com/sandeepmistry/bleno/issues/326))
### for Trackers
Some trackers need to be set `On` or `Auto` about heart rate using FItbit app for a smartphone, and sync after that.
## Install
### Install as library
Do `npm install`(or `npm i`) in your project directory.
```sh
$ cd /path/to/your/project/
$ npm i fitbit-livedata
```
After `npm install`, you can see this module in `dependencies` of your `package.json`, the key is `fitbit-livedata` and the value is the path to `node-fitbit-livedata`.
```sh
$ cat /path/to/your/project/package.json
{
"name": "",
:
"dependencies": {
"fitbit-livedata": "file:/path/to/node-fitbit-livedata"
}
}
```
### Install as CLI tool
```sh
$ npm i -g fitbit-livedata
```
## Usage
### Usage as library
```javascript
import fitbit from 'fitbit-livedata';
fitbit.on('discover', (tracker) => {
tracker.on('connecting', () => {
console.log('connecting to the tracker');
});
tracker.on('openingSession', () => {
console.log('start tracker session');
});
tracker.on('authenticating', () => {
console.log('start tracker authentication process.');
});
tracker.on('sendAuth', () => {
console.log('send authention infomation.');
});
tracker.on('authenticated', () => {
console.log('finishing tracker authentication process...');
});
tracker.on('connected', () => {
console.log('tracker is connected.');
tracker.on('disconnected', () => {
console.log('tracker is disconnected.');
// if you want to re-connect automatically.
tracker.connect();
});
});
tracker.on('data', (livedata) => {
process.stdout.write(`${JSON.stringify(livedata)}\n`);
});
tracker.connect();
});
fitbit.on('error', (error) => {
console.error(`${error}\n`);
process.exit(1);
});
const accounts = [
{
username: fitbitUser1_Username,
password: fitbitUser1_Password
},
{
username: fitbitUser2_Username,
password: fitbitUser2_Password
},
// :
];
const trackers = [];
accounts.reduce((prev, curr) => {
return prev.then(() => {
return new Promise((resolve) => {
fitbit.getTrackers(curr)
.then((trackerInfos) => {
// login succeeded
trackerInfos.forEach((trackerInfo) => {
trackers.push(trackerInfo);
});
console.log(`${trackersInfos}\n`);
resolve();
})
.catch((err) => {
// login failed
console.error(`login failed\n`);
console.error(`${err}\n`);
resolve();
});
});
});
}, Promise.resolve()).then(() => {
fitbit.scanTrackers(trackers);
});
```
### Usage as CLI tool
```sh
$ fitbit-livedata -u -p
{"device":{"name":"Charge HR","address":"XX:XX:XX:XX:XX:XX","serialNumber":"0123456789ab"},"livedata":{"time":"YYYY-MM-DDThh:mm:dd.sssZ","steps":5700,"distance":4024236,"calories":1220,"elevation":13,"veryActive":2,"heartRate":80}}
{"device":{"name":"Charge HR","address":"XX:XX:XX:XX:XX:XX","serialNumber":"0123456789ab"},"livedata":{"time":"YYYY-MM-DDThh:mm:dd.sssZ","steps":5700,"distance":4024236,"calories":1220,"elevation":13,"veryActive":2,"heartRate":82}}
:
```
If you want to connect to only one tracker, add the tracker name( e.g. "Charge HR") with `--trackername`/`-t` option.
```sh
$ fitbit-livedata -u -p -t "Charge HR"
```
## Memo
### Sequence Diagram between host, tracker and fitbit.com
[Japanese memo on Qiita](https://qiita.com/horihiro/items/03c4bef3e71539eddaad)