Web Search:
Recent Changes - Search:

BasisRetriever

Retrieve the biometrics data from your Basis Peak or Basis B1 Band fitness watch.

News: Basis Retriever v0.5 is released. This version fixes several bugs and cleans up the user interface. Simplified updating of advanced configuration items in BasisRetriever.cfg file.

What it does: Retrieves the biometric data you recorded on your Basis B1 or Basis Peak fitness watch (which Basis automatically uploads to their servers at app.mybasis.com) and stores it on your hard drive in csv format.

Project page (Sourceforge) BasisRetriever is a portable application. Just download and extract the zip file to wherever you please.

To browse and graph your downloaded Basis data, also see the Basis Viewer application, also on Sourceforge.

Basis Retriever quick introduction

Detailed instructions-- First launching BasisRetriever:

To run (Windows): In the install folder, go into the app subfolder, doubleclick on BasisRetriever.exe

To run (OS-X or Linux): In the install folder, bring up a terminal window, cd to the ./src folder, and type

 python BasisRetriever.py.

When launched, the following window is shown:

Basis Retriever starting screen

Using the program:

  1. Select a directory for saving files (top row of the display), the display will change to this:
Basis Retriever starting screen
  1. Enter your info: In the second row on the top, enter your basis website login id (email) and password.
    • Click the "save" checkbox to save your password each time you run BasisRetriever.*
  2. Choose a month: Select a year and month on the left side of the window.
    • Note: dates in the future are shown in gray; no download is possible.
  3. Download data for a particular day: Click a "metrics nn" button to download your data for a particular day.
    • Once downloaded, the number to the left of the download button is the file size in bytes.
    • If the 'Activity type into metrics' button is checked, the metrics file will also include sleep and activity data. If unchecked, you'll also have a button for each day ("sleep nn") to download a file with the day's sleep data.
    • If the entire day's worth of data was downloaded, the file size link will look like a blue text hyperlink.
    • If the file was downloaded but you hadn't yet uploaded the entire day from your watch, the link will be in orange text.
  4. Download summary data: You can also download summary data for activities and sleep for an entire month. On the second row, below the password entry box, click one of the two buttons to download. File naming:
    • Activity summary for month: YYYY-MM_basis_activities_summary.csv
    • Sleep Summary for month: YYYY-MM_basis_sleep_summary.csv
    • Note: In order to get a complete summary, do this after the month is over.
  5. View your data: I created the BasisViewer app (homepage and download) to make it easy to browse and graph your data.
  6. Sync Button: You can also have BasisRetriever automatically synchronize your data from the basis website. Click the "Sync" button to download your data for any missing days. The application is configured to go back 30 days, but you can change that; see the BasisRetriever.cfg file.
  7. Override Cache Option: For normal use, it doesn't matter if this is checked or unchecked. If unchecked, you have already downloaded data for a particular day, and press a "metrics nn" button again, BasisRetriever will use cached json data (see below) to recreate the csv file. If 'Override Cache' is checked, it will download new json files each time.

File storage and naming:

Click the 'CSV Dir' link to open up the folder containing the csv files in your system's file viewer.

  • Name of metrics file is YYYY-MM-DD_basis_metrics.csv
  • Name of summary files are YYYY-MM_basis_sleep_summary.csv and YYYY-MM_basis_activities_summary.csv.

In order to create the csv files, BasisRetriever downloads "json"-formatted files from the basis website. These are stored in the json subdirectory of the CSV directory.

  • You can change the json directory-- see the BasisRetriever.cfg file in the app subdirectory.
  • Once the csv file is created (plus the monthly summary files) you can delete the associated json files.

* Important Note:

  • Clicking the "Save" checkbox next to the password encodes your password and saves it in your BasisRetriever program directory.
  • Your password is encoded but IT IS NOT ENCRYPTED-- it can easily be decoded.
  • If this is a concern to you, do not check "Save" and enter your password each time you run this program.

Prior Versions

Edit - History - Print - Recent Changes - Search
Page last modified on April 25, 2015, at 12:30 PM