心拍スイッチFitbitアプリ開発計画

!心拍スイッチFitbitアプリ開発計画.md

心拍スイッチFitbitアプリ開発計画

開発目標

心拍情報からストレス傾向を分析して設定した閾値を上回った場合にリアルタイムでHTTPリクエストを送信するFitbitアプリを開発する。なお、送信されるHTTPリクエストはAB-ANGELSの撮影トリガーなどに利用される。

検証事項

1. アプリを起動したままにする方法を探す。どうしてもできない場合はクロックフェイスとして開発する。
2. Fitbitの画面が非表示の状態で(1)心拍データの取得、(2)ファイルの読み書き、(3)HTTPリクエストの送信ができることを確認する。

開発ステップ

第1ステップ：検証

このステップの目標は上記の検証事項を検証すること。 期間は9/19(月)〜10/2(日)の2週間。 このステップでは検証のために下記の機能を備えた心拍ログ収集FitbitアプリとクラウドAPIを作成する。

• 心拍センサーから心拍数を取得する
• 取得した心拍数を画面に表示する
• 取得した心拍数を取得日時と共にファイルに書き込む
• ファイルに書き込んだ心拍データを一定間隔（例: 1分）毎にクラウドAPIに送信する
• クラウドAPIでは受信した心拍データをストレージに保存する

作成したFitbitアプリをインストールした実機を身に付けて一定時間(例: 1時間)経過後に下記2点を確認する。

• アプリが起動したままの状態にできること
• クラウドストレージにデータ（心拍数と取得日時）が保存されていること

クラウドストレージに保存された心拍データから散布図（横軸: 取得日時、縦軸: 心拍数）を作成して可視化し、抜けなくデータを取得できていることを確認する。

このステップの成果物は下記の通り。

• 心拍ログ収集Fitbitアプリ
• クラウドAPI
• 心拍数の動作確認データ
• 心拍データの散布図

アプリを起動したままの状態にできない場合、以降のステップでクロックフェイスとして開発する

第2ステップ：プロトタイプ作成

このステップの目標は開発目標の実現可能性を検証すること。 期間は10/3(月)〜10/9(日)の1週間。 このステップでは心拍ログ収集Fitbitアプリの機能に加え、下記の機能を備えた心拍スイッチFitbitアプリ／クロックフェイスのプロトタイプとクラウドAPIを作成する。

• ファイルに書き込んだ心拍データからストレス傾向を算出する（ストレス傾向の算出には心拍変動のローレンツプロットを用いる）
• 算出したストレス傾向が一定の閾値を上回る場合にHTTPリクエストを送信する
• クラウドAPIではHTTPリクエストの受信記録をストレージに保存する

作成したFitbitアプリ／クロックフェイスをインストールした実機を身に付け、ストレス傾向が高い状態を検出した場合にHTTPリクエストが送信されることを確認する。

ストレス傾向が高い状態を検出するのが困難な場合、HTTPリクエストの送信条件を「ストレス傾向が一定の閾値を上回った時」から「心拍数が一定の閾値を上回った時」に一時的に変更した上で、運動するなどして心拍数を上げることで動作を確認する。

単純に実装するとストレス傾向や心拍数が閾値を上回った時にHTTPリクエストが頻繁（1秒間に1回）に送信されることになるので、一度HTTPリクエストを送信したら一定の閾値（HTTPリクエスト送信の閾値とは異なる）を下回るまでHTTPリクエストの送信を抑制するなど実装を工夫する。

動作確認後はクラウドストレージに保存された心拍データとHTTPリクエストの受信記録を突合し、正しく動作していることを検証する。

このステップの成果物は下記の通り。

• 心拍スイッチFitbitアプリ／クロックフェイスのプロトタイプ
• クラウドAPI（HTTPリクエストの受信記録機能が追加された）
• 心拍データとHTTPリクエスト受信記録の動作確認データ
• 正しく動作していることの検証結果

第3ステップ：仕様策定

このステップの目標は第4ステップで作成するプロダクトの仕様書を作成すること。 期間は10/10(月)〜10/16(日)の1週間。 このステップでは下記を規定する仕様書を作成する。

• Fitbitアプリ／クロックフェイスのユーザーインタフェース
• 設定項目／設定画面
• アプリ／クロックフェイスとコンパニオンの通信仕様
• HTTPリクエストの通信仕様

このステップ計画については先行するステップの実行を通じて得られた知見をもとに変更する。

第4ステップ：プロダクト作成

このステップの目標は第3ステップで規定した仕様書に基づいてプロダクトを作成すること。 期間は10/17(月)〜10/30(日)の2週間。

このステップ計画については先行するステップの実行を通じて得られた知見をもとに変更する。

!心拍スイッチFitbitアプリ開発計画第1ステップ：検証報告書.md

心拍スイッチFitbitアプリ開発計画 第1ステップ：検証 報告書

結論

• 計画書で定義した要件の全てを備えたFitbitアプリとクラウドAPIが完成した
• 1時間以上アプリを起動したままの状態にできることを実験で検証することができた
• クラウドストレージにデータ（心拍数と取得日時）が保存されていることを実験で検証することができた
• 5〜10分程度の期間のデータに欠損が生じていた、原因は不明

成果物

• 心拍ログ収集Fitbitアプリのソースコード（fitbit-から始まるファイル一式）
• クラウドAPIのソースコード
• 心拍数の動作確認データ
• 心拍データの散布図

実験

• 日時: 2022年9月29日(木) 10:40〜11:42
• 場所: 薄田自宅
• 実験者: 薄田
• 目的: アプリを起動したままの状態にできること／クラウドストレージにデータ保存できることの検証
• 方法: アプリをインストールしたFitbitデバイスを身につけて1時間以上過ごす
• 使用したデバイス: Fitbit Sense
• 使用したクラウド: Google Cloud Platform

アプリを起動したままにする方法

Fitbit公式ドキュメントのAppbit APIのページに下記の記載があります。

Whether the app should time out after a period of inactivity. The default is true after an application is launched. The value true means that the application will be killed after 2 minutes of inactivity, and false means that the application will not be killed due to inactivity, and may run indefinitely.

設定のコード例を下記に示します。

import { me as appbit } from "appbit";
appbit.appTimeoutEnabled = false;

api-heartrate.ts

// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
import { Storage } from '@google-cloud/storage'
import type { NextApiRequest, NextApiResponse, PageConfig } from 'next'

type Data = {
  name: string
}

export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse<Data>
) {
  if (req.method !== 'POST') {
    res.status(405).end()
    return
  }

  const storage = new Storage()
  const bucket = storage.bucket(process.env.BUCKET as string)
  const file = bucket.file(new Date().toISOString() + '.txt')
  const buffer = await new Promise<Buffer>((resolve, reject) => {
    const chunks = [] as Buffer[]

    req.on('data', (chunk: Buffer) => chunks.push(chunk))
    req.on('end', () => resolve(Buffer.concat(chunks)))
    req.on('error', (err) => reject(err))
  })

  await file.save(buffer)
  res.status(201).end()
}

export const config: PageConfig = {
  api: {
    bodyParser: false,
  },
}

fitbit-app-index.js

/*
 * Entry point for the watch app
 */
import * as document from "document";
import { HeartRateSensor } from "heart-rate";
import * as fs from "fs";
import * as messaging from "messaging";
import { me as appbit } from "appbit";

appbit.appTimeoutEnabled = false; 

let demotext = document.getElementById("demotext");
let myButton = document.getElementById("button-1");
const FILENAME = 'heartrate.txt';

fs.unlinkSync(FILENAME) ;

const sensors = [];

let g_upload = true;

updateButtonLabel();

if (HeartRateSensor) {
  const hrm = new HeartRateSensor({ frequency: 1 });
  hrm.addEventListener("reading", () => {
    const line = JSON.stringify({
      date: new Date().toISOString(),
      heartRate: hrm.heartRate ? hrm.heartRate : 0,
    }) + '\n'

    const buffer = new Uint8Array(line.length)
    
    for (let i = 0; i < line.length; i += 1) {
      buffer[i] = line.charCodeAt(i)
    }

    const fd = fs.openSync(FILENAME, 'a')

    fs.writeSync(fd, buffer)
    fs.closeSync(fd)

    demotext.text = JSON.stringify({
      heartRate: hrm.heartRate ? hrm.heartRate : 0
    });
  });
  sensors.push(hrm);
  hrm.start();
}

myButton.addEventListener('click', (event) => {
  g_upload = !g_upload;
  updateButtonLabel();
})

setInterval(() => {
  if (g_upload) {
    uploadData();
  }
}, 10000)

function uploadData() {
  try {
    if (fs.existsSync('/private/data/' + FILENAME)) {
      console.log('/private/data/' + FILENAME + ' exists');
      console.log('readyState: ' + messaging.peerSocket.readyState + ', OPEN = ' + messaging.peerSocket.OPEN)
      if (messaging.peerSocket.readyState === messaging.peerSocket.OPEN) {
        console.log('peerSocket OPEN');
        const text = fs.readFileSync(FILENAME, 'utf-8');
        const lines = text.split('\n')
        lines.pop()
        const chunk = 10
        const max = Math.ceil(lines.length / chunk)
        
        for (let i = 0; i < max; i += 1) {
          const from = i * chunk
          const to = (i + 1) * chunk
          const partial = lines.slice(from, to).join('\n')

          console.log(partial.length);
          console.log(partial);
          messaging.peerSocket.send(partial);
        }

        fs.unlinkSync(FILENAME) ;
      }
    }
  } catch (err) {
    console.error(err.message);
  }
}

function updateButtonLabel() {
  if (g_upload) {
    myButton.text = 'UPLOAD ON'
  } else {
    myButton.text = 'UPLOAD OFF'
  }
}

fitbit-companion-index.js

/*
 * Entry point for the companion app
 */

import * as messaging from "messaging";

console.log("Companion code started");

messaging.peerSocket.addEventListener("message", async (event) => {
  const url = 'https://heartrate-poc-webapp-xdblopffpq-an.a.run.app/api/heartrate'
  try {
    await fetch(url, {
      method: 'POST',
      body: event.data,
    })  
  } catch (err) {
    console.error(err.message)
  }
});

fitbit-resources-index.view

<svg class="background">
  <text id="demotext" x="50%" y="50%+15"></text>
  <use id="button-1" href="#text-button" class="text-button bottom application-fill" />
</svg>

fitbit-resources-styles.css

.background {
  viewport-fill: fb-cyan;
}

#demotext {
  fill: black;
  font-size: 32;
  font-family: System-Regular;
  font-weight: bold;
  text-anchor: middle;
  text-length: 99;
}

.application-fill           { fill: fb-yellow; }
.foreground-fill            { fill: fb-white; }
.background-fill            { fill: fb-black; }

#button-1 #text {
  text-buffer: "";
}
 

fitbit-resources-widget.def

<svg>
  <defs>
    <link rel="stylesheet" href="styles.css" />
    <link rel="import" href="/mnt/sysassets/system_widget.defs" />
    <link rel="import" href="/mnt/sysassets/widgets/text_button.defs" />
  </defs>
</svg>

heartrate.csv

scatter.png