[fitbit] 2. PythonでFitbit APIを使ってデータ取得 その2 fitbit-pythonによる睡眠データの取得とmatplotlibによる表示

fitbit
2021.05.19

はじめに

fitbitとは、心拍数、歩数や睡眠をトラッキングするために腕に着用するタイプのスマートウォッチです。日々の健康状態を把握するのにとても役立っています。ここでは、アプリの登録からtokenの取得までを解説したその１の続きとして、Fitbit APIを使って睡眠データを取得してmatplotlibで表示するところまで解説します。

その１はこちら↓です。

[fitbit] 1. PythonでFitbit APIを使ってデータ取得 その1 アプリの登録とtokenの取得
fitbitとは、心拍数、歩数や睡眠をトラッキングするために腕に着用するタイプのスマートウォッチです。日々の健康状態を把握するのにとても役立っています。ここでは、Fitbit APIを使ってデータを取得するために、アプリの登録からtokenの取得まで解説します。
sabopy.com
2021.05.18

手順

fitbit-pythonのインストール

pip install fitbit

でfitbit APIをpythonで操作できるモジュールをインストールします。

fitbit-pythonのAPI VERSIONの変更

pip show fitbit

でfitbit-pythonがインストールされた場所を確認します。こうすると、Nameやversionなどに加えてLocationの情報が表示されます。locationの場所にあるapi.pyを開いて、

API_VERSION = 1.0

を

API_VERSION = 1.2

に変更して、保存して閉じます。２箇所あります。

これをすることでWake, Rem, Light, Deepの4段階の睡眠レベルの情報を受け取れるようになります。

モジュールのインポート

これ以降の処理はjupyter lab上で行います。

import fitbit
from ast import literal_eval
import pandas as pd
import matplotlib.pyplot as plt
import matplotlib.dates as mdates
import numpy as np
plt.style.use('ggplot')
view raw fitbit_sleep.py hosted with ❤ by GitHub

バージョン

#version
import matplotlib
print(matplotlib.__version__)
3.4.2
print(fitbit.__version__)
0.3.1
print(pd.__version__)
1.2.4
print(np.__version__)
1.20.2
view raw fitbit_sleep.py hosted with ❤ by GitHub

CLIENT_ID, tokenなどを定義

CLIENT_ID = "######"
CLIENT_SECRET = "################################"
TOKEN_FILE = "token.txt"
tokens = open(TOKEN_FILE).read()
token_dict = literal_eval(tokens)
access_token = token_dict['access_token']
refresh_token = token_dict['refresh_token']
view raw fitbit_sleep.py hosted with ❤ by GitHub

その1で取得したCLIENT_IDとCLIENT_SECRETとtoken.txtをここで使います。token.txtは実行ファイルと同じ場所に置いておきます。

認証

def updateToken(token):
f = open(TOKEN_FILE, 'w')
f.write(str(token))
f.close()
return
client = fitbit.Fitbit(CLIENT_ID, CLIENT_SECRET,
access_token = access_token, refresh_token = refresh_token, refresh_cb = updateToken)
view raw fitbit_sleep.py hosted with ❤ by GitHub

fitbit.Fitbit()により、認証を行います。updateToken関数はtokenの更新用の関数でrefresh_cb に updateTokenとすることでtokenの期限切れの際に随時更新してくれるようになります。

睡眠データの取得

#睡眠データの取得
DATE = "2021-05-12"# 日付
data_sleep = client.sleep(DATE)
data_sleep_1 = data_sleep["sleep"][0]["levels"]["data"]
data_sleep_1 = pd.DataFrame.from_dict(data_sleep_1)
data_sleep_1.index=pd.to_datetime(data_sleep_1["dateTime"])
view raw fitbit_sleep.py hosted with ❤ by GitHub

DATEを設定し、client.sleep(DATE)とすることで睡眠データが得られます。

取得したdata_sleep_1をpandasのDataFrameにすると以下のようになります。

dateTime level seconds
dateTime
2021-05-11 23:08:30 2021-05-11T23:08:30.000 wake 600
2021-05-11 23:18:30 2021-05-11T23:18:30.000 light 2850
2021-05-12 00:06:00 2021-05-12T00:06:00.000 deep 420
2021-05-12 00:13:00 2021-05-12T00:13:00.000 light 2070
2021-05-12 00:47:30 2021-05-12T00:47:30.000 wake 330
2021-05-12 00:53:00 2021-05-12T00:53:00.000 light 1800
2021-05-12 01:23:00 2021-05-12T01:23:00.000 rem 360
2021-05-12 01:29:00 2021-05-12T01:29:00.000 light 2220
2021-05-12 02:06:00 2021-05-12T02:06:00.000 wake 300
2021-05-12 02:11:00 2021-05-12T02:11:00.000 light 1770
2021-05-12 02:40:30 2021-05-12T02:40:30.000 deep 720
2021-05-12 02:52:30 2021-05-12T02:52:30.000 light 750
2021-05-12 03:05:00 2021-05-12T03:05:00.000 rem 1200
2021-05-12 03:25:00 2021-05-12T03:25:00.000 light 2880
2021-05-12 04:13:00 2021-05-12T04:13:00.000 rem 2190
2021-05-12 04:49:30 2021-05-12T04:49:30.000 light 1200
2021-05-12 05:09:30 2021-05-12T05:09:30.000 deep 1770
2021-05-12 05:39:00 2021-05-12T05:39:00.000 light 30
2021-05-12 05:39:30 2021-05-12T05:39:30.000 wake 240
2021-05-12 05:43:30 2021-05-12T05:43:30.000 light 1140
2021-05-12 06:02:30 2021-05-12T06:02:30.000 wake 270
2021-05-12 06:07:00 2021-05-12T06:07:00.000 rem 300
2021-05-12 06:12:00 2021-05-12T06:12:00.000 wake 510

sleepレベルを数値データに変換

# sleepレベルを数値データに変換して新たな列で追加
data_sleep_1.loc[data_sleep_1['level']=="wake","level_int"]= 3
data_sleep_1.loc[data_sleep_1['level']=="rem","level_int"]= 2
data_sleep_1.loc[data_sleep_1['level']=="light","level_int"]= 1
data_sleep_1.loc[data_sleep_1['level']=="deep","level_int"]= 0
data_sleep_1 = data_sleep_1.astype({'level_int': 'int'})
view raw fitbit_sleep.py hosted with ❤ by GitHub
dateTime level seconds level_int
dateTime
2021-05-11 23:08:30 2021-05-11T23:08:30.000 wake 600 3
2021-05-11 23:18:30 2021-05-11T23:18:30.000 light 2850 1
2021-05-12 00:06:00 2021-05-12T00:06:00.000 deep 420 0
2021-05-12 00:13:00 2021-05-12T00:13:00.000 light 2070 1
2021-05-12 00:47:30 2021-05-12T00:47:30.000 wake 330 3
2021-05-12 00:53:00 2021-05-12T00:53:00.000 light 1800 1
2021-05-12 01:23:00 2021-05-12T01:23:00.000 rem 360 2
2021-05-12 01:29:00 2021-05-12T01:29:00.000 light 2220 1
2021-05-12 02:06:00 2021-05-12T02:06:00.000 wake 300 3
2021-05-12 02:11:00 2021-05-12T02:11:00.000 light 1770 1
2021-05-12 02:40:30 2021-05-12T02:40:30.000 deep 720 0
2021-05-12 02:52:30 2021-05-12T02:52:30.000 light 750 1
2021-05-12 03:05:00 2021-05-12T03:05:00.000 rem 1200 2
2021-05-12 03:25:00 2021-05-12T03:25:00.000 light 2880 1
2021-05-12 04:13:00 2021-05-12T04:13:00.000 rem 2190 2
2021-05-12 04:49:30 2021-05-12T04:49:30.000 light 1200 1
2021-05-12 05:09:30 2021-05-12T05:09:30.000 deep 1770 0
2021-05-12 05:39:00 2021-05-12T05:39:00.000 light 30 1
2021-05-12 05:39:30 2021-05-12T05:39:30.000 wake 240 3
2021-05-12 05:43:30 2021-05-12T05:43:30.000 light 1140 1
2021-05-12 06:02:30 2021-05-12T06:02:30.000 wake 270 3
2021-05-12 06:07:00 2021-05-12T06:07:00.000 rem 300 2
2021-05-12 06:12:00 2021-05-12T06:12:00.000 wake 510 3

睡眠レベルの経時的な変化を表示

#show
t = data_sleep_1.index.values
level = data_sleep_1["level_int"].values
fig,ax=plt.subplots(dpi=200)
ax.step(t,level,"-",where='post',lw=2)
locator = mdates.AutoDateLocator()
formatter = mdates.ConciseDateFormatter(locator)
ax.xaxis.set_major_locator(locator)
ax.xaxis.set_major_formatter(formatter)
ax.set(yticks=np.arange(4),yticklabels=["Deep","Light","Rem","Wake"])
ax.set(xlabel="Time", ylabel="Sleep level")
plt.savefig("sleep1.png",dpi=130)
plt.show()
view raw fitbit_sleep.py hosted with ❤ by GitHub

睡眠レベルの経時的な変化をax.stepでステップ状のプロットで表示します。以下の図を作成することができます。

コードをダウンロード(.pyファイル)

参考

Overview — Python-Fitbit 0.3.0 documentation
python-fitbit.readthedocs.io
PythonからFitbit APIを使ってデータを取得する（OAuth2） - ブログを書くまでが
昨年2016年にFitbitデビューしました。APIを使って遊んでみたかったのですができていませんでした。 以前この記事でもFitbit APIを使ってみたい的なことを言ったのでこの度やってみました。 この手のやってみた系は日本や海外ブログ...
sakanaaas.hateblo.jp
Amazon.co.jp: Fitbit Charge 5 ブラック-グラファイト日本正規品 メーカー保証1年 最大7日間のバッテリー Suica対応 GPS搭載 健康指標ダッシュボード 心拍計測と睡眠スコア 活動量計 : スポーツ＆アウトドア
Amazon.co.jp: Fitbit Charge 5 ブラック-グラファイト日本正規品 メーカー保証1年 最大7日間のバッテリー Suica対応 GPS搭載 健康指標ダッシュボード 心拍計測と睡眠スコア 活動量計 : スポーツ＆アウト...
amzn.to

コメント

  1. 内山優希 より:
    2021年11月16日 4:47 PM

    度々申し訳ございません。
    pipでpython3.10ではmatplotlibをインストールできず、python2.7を使おうとしています。
    そうしましたら、

    py -2.7 -m pip install matplotlib
    DEPRECATION: Python 2.7 will reach the end of its life on January 1st, 2020. Please upgrade your Python as Python 2.7 won’t be maintained after that date. A future version of pip will drop support for Python 2.7. More details about Python 2 support in pip, can be found at https://pip.pypa.io/en/latest/development/release-process/#python-2-support
    Requirement already satisfied: matplotlib in c:\python27\lib\site-packages (2.2.5)
    Requirement already satisfied: pyparsing!=2.0.4,!=2.1.2,!=2.1.6,>=2.0.1 in c:\python27\lib\site-packages (from matplotlib) (2.4.7)
    Requirement already satisfied: python-dateutil>=2.1 in c:\python27\lib\site-packages (from matplotlib) (2.8.2)
    Requirement already satisfied: six>=1.10 in c:\python27\lib\site-packages (from matplotlib) (1.16.0)
    Requirement already satisfied: pytz in c:\python27\lib\site-packages (from matplotlib) (2021.3)
    Requirement already satisfied: kiwisolver>=1.0.1 in c:\python27\lib\site-packages (from matplotlib) (1.1.0)
    Requirement already satisfied: backports.functools-lru-cache in c:\python27\lib\site-packages (from matplotlib) (1.6.4)
    Requirement already satisfied: numpy>=1.7.1 in c:\python27\lib\site-packages (from matplotlib) (1.16.6)
    Requirement already satisfied: cycler>=0.10 in c:\python27\lib\site-packages (from matplotlib) (0.10.0)
    Requirement already satisfied: setuptools in c:\python27\lib\site-packages (from kiwisolver>=1.0.1->matplotlib) (41.2.0)
    WARNING: You are using pip version 19.2.3, however version 20.3.4 is available.
    You should consider upgrading via the ‘python -m pip install –upgrade pip’ command.

    このようなエラーとなってしまい、どちらのバージョンでもインストールできないのですが、どのバージョンでインストールされていますでしょうか。また、2.7か3.10において使用可能になる方法が見つからないのですが、どう対処されていますでしょうか。

    返信
    • sabopy より:
      2021年11月16日 7:19 PM

      python3.10はまだ出たばかりで、対応してないライブラリが多そうですので、python3.9でトライしてみてはいかがでしょうか。

      返信
  2. 内山優希 より:
    2021年11月19日 4:12 PM

    python3.9でトライしたところ成功しました。ありがとうございます。

    また、次に実行をしようとしたところ、

    KeyError: ‘activities-heart-intraday'(34行目)

    このようなエラーとなったのですが、このコードは既に取得しているデータを表示することはできるのでしょうか。

    また、この部分で何か手を加えたことがありましたら教えていただけると嬉しいです。度々申し訳ございません。

    返信
    • sabopy より:
      2021年11月19日 11:05 PM

      KeyError: ‘activities-heart-intraday’の原因はアプリケーションのタイプがPersonal以外になっている可能性が高いそうです。
      アプリの登録の部分のOAuth 2.0 Application Type（アプリのタイプ）を　Personalにし、再度登録してみてください。
      参考：　https://github.com/pkpio/fitbit-googlefit/issues/2

      返信
  3. 内山優希 より:
    2021年11月22日 12:28 PM

    この部分は完了しました。ありがとうございます。
    再度今度は

    Traceback (most recent call last):
    File “C:\Users\yuuki\AppData\Local\Programs\Python\Python39\lib\site-packages\pandas\core\indexes\base.py”, line 3361, in get_loc
    return self._engine.get_loc(casted_key)
    File “pandas\_libs\index.pyx”, line 76, in pandas._libs.index.IndexEngine.get_loc
    File “pandas\_libs\index.pyx”, line 108, in pandas._libs.index.IndexEngine.get_loc
    File “pandas\_libs\hashtable_class_helper.pxi”, line 5198, in pandas._libs.hashtable.PyObjectHashTable.get_item
    File “pandas\_libs\hashtable_class_helper.pxi”, line 5206, in pandas._libs.hashtable.PyObjectHashTable.get_item
    KeyError: ‘time’

    The above exception was the direct cause of the following exception:

    Traceback (most recent call last):
    File “c:\Users\yuuki\AppData\Local\Programs\Python\Python39\04e9973678c16de50b5027ba6012c2a5-46b41b8a9cbb22a49e0d179df23b7b57c386b295\heartbeat_fitbit.py”, line 71, in
    times = date_ser.str.cat(heart_rat[‘time’],sep=’ ‘)
    File “C:\Users\yuuki\AppData\Local\Programs\Python\Python39\lib\site-packages\pandas\core\frame.py”, line 3458, in __getitem__
    indexer = self.columns.get_loc(key)
    File “C:\Users\yuuki\AppData\Local\Programs\Python\Python39\lib\site-packages\pandas\core\indexes\base.py”, line 3363, in get_loc
    raise KeyError(key) from err
    KeyError: ‘time’

    このようなtimeについてエラーが出てしまい、検索をかけても全くわからなく、止まっている状態です。このようなエラーは出ましたでしょうか。

    返信
    • sabopy より:
      2021年11月22日 11:42 PM

      エラーはtimes = date_ser.str.cat(heart_rat[‘time’],sep=’ ‘)の部分で出ているようです。str.catはDataFrameの文字列を結合する関数であり、KeyError: ‘time’と出ているので、heart_ratという名前のDataFrameに、timeという名前のカラムがないことが原因と思われます。

      返信
  4. shida より:
    2021年12月12日 3:16 PM

    手順通りに行ってきたと思いますが、
    以下のエラーが出ます。

    HTTPUnauthorized: Authorization Error: Invalid authorization token type

    この場合、どうしたらよいでしょうか？

    返信
  5. アツオ より:
    2022年3月15日 6:00 PM

    大変遅ればせながら上手く行きました。
    curlに不慣れで、\→^に変えたら解決しました。
    早々にご回答頂きましてありがとうございました！

    返信