Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SVendittelli/MMM-fitbit
MagicMirror Module for fitbit
https://github.com/SVendittelli/MMM-fitbit
Last synced: 3 months ago
JSON representation
MagicMirror Module for fitbit
- Host: GitHub
- URL: https://github.com/SVendittelli/MMM-fitbit
- Owner: SVendittelli
- Created: 2016-03-31T14:14:08.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-18T11:57:25.000Z (almost 2 years ago)
- Last Synced: 2024-06-29T09:36:03.725Z (5 months ago)
- Language: Python
- Size: 1.29 MB
- Stars: 25
- Watchers: 6
- Forks: 15
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-Fitbit**
README
MMM-fitbit
===
[MagicMirror](https://github.com/MichMich/MagicMirror) Module for getting fitbit data. First time users follow setup instructions, if your tokens get lost run `setupAccess.py` again without arguments and accept reading from `credentials.ini`.
Dependencies
---
* [python-shell](https://www.npmjs.com/package/python-shell) --- `npm install python-shell`
* [python-fitbit](https://github.com/orcasgit/python-fitbit) --- `sudo pip install -r python/fitbit/requirements.txt`
Setup
---
* As with all modules, use `git clone ` in the `modules` directory to download the module
* Goto [fitbit](https://dev.fitbit.com/) to register a new app (sign in with your fitbit account)
* Give your app a catchy name and description
* Your personal website, organisation, and organisation website can be whatever you like
* Check browser and personal for OAuth settings
* Callback URL **MUST BE** `http://127.0.0.1:8080/`
* Give your app read & write permissions (read-only untested)
* Note your:
* "OAuth 2.0 Client ID" --- (client_id)
* "Client (Consumer) Secret" --- (client_secret)
* (You can access these again later via manage my apps at the same link as above)
* Navigate to `MMM-fitbit` in the modules directory
* Install dependancies using the listed commands
* Navigate to the `python` directory in `MMM-fitbit`
* Create blank files `tokens.ini` and `credentials.ini` or duplicate their `.sample` files
* Via the command line on your Pi (**NOT via SSH**), run `sudo python setupAccess.py`. You must either:
* Pass it your client_id and client_secret as arguments
* Run it without arguments and have it read from `credentials.ini` (you can use this if you have already setup the module but need a fresh set of tokens)
* Run it without arguments and enter your client_id and client_secret when prompted
* Login using your fitbit credentials (if you are not already) and allow access to all options (if you do not some features may not work, but you may revoke app access and rerun `sudo python setupAccess.py` to change these)
* Add the example config to your config (entering relavent credentials)
* Start your MagicMirror!
Config
---
### Example config
````javascript
{
module: 'MMM-fitbit',
position: 'top_center',
config: [
credentials: {
client_id: ,
client_secret: ,
},
resources: [
'steps',
'floors',
'caloriesOut',
'distance',
'activeMinutes',
'sleep',
'heart'
],
update_interval: 60
]
},
````
### Explanation
* (Required) `credentials`:
* (Required) `client_id`: From https://dev.fitbit.com/
* (Required) `client_secret`: From https://dev.fitbit.com/
* (Required) `resources`: List of resources to display on Mirror. May take any combination of `'steps', 'floors', 'caloriesOut', 'distance', 'activeMinutes', 'sleep', 'heart'`
* (Optional) `update_interval` - (default value of `60`): in the amount of time in minutes to wait before fetching new fitbit data. This must not be done too often otherwise fitbit will not send new tokens and an uncaught exception will be thrown. This happens after approximately 150 requests in an hour, so updates should be no more frequent than once every minute for safety.
TODO
---
See [here](TODO.md).