Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caarmen/walkingpad-fitbit
Send walkingpad data to fitbit
https://github.com/caarmen/walkingpad-fitbit
Last synced: 11 days ago
JSON representation
Send walkingpad data to fitbit
- Host: GitHub
- URL: https://github.com/caarmen/walkingpad-fitbit
- Owner: caarmen
- License: mit
- Created: 2024-07-13T10:35:02.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-03T16:23:09.000Z (3 months ago)
- Last Synced: 2024-08-04T15:23:41.163Z (3 months ago)
- Language: Python
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# walkingpad-fitbit
Send walkingpad data to fitbit.
_This is a personal hobby app and is not associated with WalkingPad in any way._
This program:
* Connects to your WalkingPad treadmill over bluetooth.
* Receives walking data from the treadmill, every second (the interval is configurable).
* Sends a treadmill workout to FitBit when the walk stops.
## Configuration
This program requires a Fitbit developer application.
Create an application in the [Fitbit developer dashboard](https://dev.fitbit.com/apps/).
Note the client id and client secret.
Store them in one of two ways:
### Option 1: `.env` file
Copy the `.env.template` file to `.env`.
Enter your Fitbit application's client id and client secret.
### Option 2: Environment variables
Set the following environment variables:
* `FITBIT_OAUTH_CLIENT_ID`
* `FITBIT_OAUTH_CLIENT_SECRET`
## Usage
### Get your device's name
Use the `ph4_walkingpad` tool to find the name of your treadmill:
`python -m ph4_walkingpad.main --scan`
This outputs a line similar to the following:
```
Device: [ 0], XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX, KS-ST-A1P, ['0000fe00-0000-1000-8000-00805f9b34fb']
```
In this case, the device name is **KS-ST-A1P**.
Use this name when using the `walkingpadfitbit` command.
### Command options
```
% python -m walkingpadfitbit.main --help
usage: main.py [-h] [-d MONITOR_DURATION_S] [-p POLL_INTERVAL_S] [-m {plaintext,richtext,json}] device_name
positional arguments:
device_name Name of the walkingpad device (ex: KS-ST-A1P).
options:
-h, --help show this help message and exit
-d MONITOR_DURATION_S, --monitor-duration MONITOR_DURATION_S
Monitoring duration in seconds. By default the program monitors forever.
-p POLL_INTERVAL_S, --poll-interval POLL_INTERVAL_S
Poll interval in seconds (default 1.0).
-m {plaintext,richtext,json}, --display-mode {plaintext,richtext,json}
Display mode
```
### Example command
This commmand will collect data every second from the treadmill:
`python -m walkingpadfitbit.main KS-ST-A1P`
## Authentication
The first time you run the app, you will be prompted to log in to Fitbit, to grant authorization
(to the Fitbit app you created). After granting authorization, Fitbit will attempt to redirect to the
application. Since this is a command-line tool, there is no server to which Fitbit can redirect. It redirects
to a Github page which exists only to avoid an error due to the lack of a server. Copy the url of the page,
and paste it in the command line tool to complete the login.
How does it work? The application uses the OAuth flow: [Code Grant Flow with PKCE](https://dev.fitbit.com/build/reference/web-api/developer-guide/authorization/#Authorization-Code-Grant-Flow-with-PKCE) for a "Server" application type. In particular, under the hood, it uses a code verifier, which is not communicated in the browser, and is required for the authentication to complete.