OrpheInsole~ OrpheInsole

ORPHE INSOLE Module Javascript class

Constructor

new OrpheInsole(idopt)

初期化関数

Parameters:
NameTypeAttributesDefaultDescription
idnumber<optional>
0

id コアの番号(0 or 1)を指定します。

Properties
NameTypeDescription
ORPHE_INFORMATIONstring

"01a9d6b5-ff6e-444a-b266-0be75e85c064" SERVICE_UUID

ORPHE_DEVICE_INFORMATIONstring

"24354f22-1c46-430e-a4ab-a1eeabbcdfc0" CHARACTERISTIC_UUID

ORPHE_OTHER_SERVICEstring

"db1b7aca-cda5-4453-a49b-33a53d3f0833" SERVICE_UUID

ORPHE_SENSOR_VALUESstring

"f3f9c7ce-46ee-4205-89ac-abe64e626c0f" CHARACTERISTIC_UUID

ORPHE_STEP_ANALYSISstring

"4eb776dc-cf99-4af7-b2d3-ad0f791a79dd" CHARACTERISTIC_UUID

Members

acc

加速度センサの値を保存する連想配列です。

Properties
NameTypeDescription
accObject

加速度センサの値

connectionState

接続状態を返す(UI 表示用)。

  • 'connected' : GATT 接続中
  • 'reconnecting' : 自動再接続の試行中
  • 'connecting' : begin() による接続処理中
  • 'disconnected' : 上記以外

converted_acc

加速度レンジに合わせて変換した加速度センサの値を保存する連想配列です。

converted_gyro

ジャイロレンジに合わせて変換したジャイロセンサの値を保存する連想配列です。

debug

デバッグログ(console.info)の出力を有効にするフラグです。 接続トラブル調査時に true にしてください。

delta

加速度値から2回積分で基準フレーム間の移動距離を求めた変数です

Properties
NameTypeDescription
deltaObject

距離

device_information

デバイスインフォメーションを取得して保存しておく連想配列です。begin()を呼び出すとデバイスから値を取得して初期化されます。

Properties
NameTypeDescription
device_informationObject

デバイス情報

Properties
NameTypeDescription
batterynumber

バッテリー残量(少ない:0、普通:1、多い:2)

mount_positionnumber

コアモジュール取り付け位置(左右情報) bit0 : 左右 bit1 : 0(足底) / 1(足背) 足底 : 左、右:0=(0000 0000b), 1=(0000 0001b)、 足背 : 左、右:2(=0000 0010b), 3(=0000 0011b)

rangeObject

加速度とジャイロセンサの感度設定

Properties
NameTypeDescription
accnumber

加速度レンジ( 2, 4, 8, 16(g):0, 1, 2, 3)

gyronumber

ジャイロレンジ(250, 500, 1000, 2000(°/s):0, 1, 2, 3)

euler

オイラー角を保存する連想配列です。this.quatから計算されています。

Properties
NameTypeDescription
eulerObject

オイラー角

Properties
NameTypeDescription
pitchnumber

ピッチ

rollnumber

ロール

yawnumber

ヨー

gait

歩容解析のデータを保存しておく連想配列です。 注意: ORPHE INSOLE のファームウェアは現状 STEP_ANALYSIS 通知に未対応のため、 この値が更新されることはありません(FW対応待ち)。

Properties
NameTypeDescription
gaitObject

歩容解析のデータ

gyro

ジャイロセンサの値を保存する連想配列です。

Properties
NameTypeDescription
gyroObject

ジャイロセンサの値

interpolation

データ欠損時に線形補完をするかどうかのオプション設定(beginのオプションで設定可能)。この設定は200Hz sensor_valuesのacc, gyro, quatのみに適用されます。

press

圧力センサ(6ch)の最新値を保存する連想配列です。

Properties
NameTypeDescription
pressObject

圧力センサの値

Properties
NameTypeDescription
valuesArray.<number>

6チャネル分のADC生値

pronation

プロネーションのデータを保存しておく連想配列です。(STEP_ANALYSIS FW対応待ち)

quat

クォータニオンを保存する連想配列です。

Properties
NameTypeDescription
quatObject

クォータニオン

Properties
NameTypeDescription
wnumber

w

xnumber

x

ynumber

y

znumber

z

steps_number

歩数カウントを保存する変数

stride

ストライドのデータを保存しておく連想配列です。(STEP_ANALYSIS FW対応待ち)

Methods

_characteristicFor(uuid) → {BluetoothRemoteGATTCharacteristic}

uuid 名に対応する characteristic を返す(内部用)。 通常は connectGATT() が UUID 別に保持したものを返す。 後方互換のため、キャッシュ未登録時は dataCharacteristic にフォールバックする (dataCharacteristic を直接注入している既存コード・テストを壊さない)。

Parameters:
NameTypeDescription
uuidstring
Returns:
Type: 
BluetoothRemoteGATTCharacteristic

(async) autoStartWatchingAdvertisements()

アドバタイズメント監視を自動開始(機能が利用可能な場合のみ)

(async) begin(notification_typeopt, optionsopt) → {Promise.<string>}

begin BLE connection SENSOR_VALUESのセンサー値の取得を開始します。

Parameters:
NameTypeAttributesDefaultDescription
notification_typestring<optional>
"SENSOR_VALUES"

SENSOR_VALUES

optionsobject<optional>
Properties
NameTypeAttributesDefaultDescription
streamingModenumber<optional>
4

データストリーミングモード(1, 3, 4)

autoReconnectboolean<optional>
false

切断時の自動再接続を有効化

reconnectIntervalMsnumber<optional>
3000

再接続試行の間隔

reconnectMaxAttemptsnumber<optional>
120

再接続の最大試行回数

Returns:
Type: 
Promise.<string>

clear()

接続情報をクリアします。

connectGATT(uuid)

GATT通信を始めるための関数。read, write, startNotify, stopNotifyが呼び出されるとscanと一緒に呼び出されます。

Parameters:
NameTypeDescription
uuidstring

dataChanged(self, uuid)

サーバからのデータを受信したときに呼び出される関数です。この関数は、characteristicvaluechangedイベントが発生したときに呼び出されます。

Parameters:
NameTypeDescription
selffunction
uuidstring

disconnect()

BLEデバイスとの接続を切断します。デバイス接続をマニュアルで切断する場合には reset() を利用してください。切断だけでなくクラス内のメンバ変数もクリア初期化する必要があり、reset()を利用するとそれらの処理が行われます。

forgetLastBluetoothDevice()

最後に接続成功した Bluetooth デバイス情報を忘れる。 次回 begin() 時に手動選択ダイアログから別デバイスへ切り替えたい場合に利用する。

(async) getDateTime() → {Promise.<object>}

Date Timeを取得する 0 year 0-255 西暦から2000を引いた数 1 month 2 day 3 hour 4 minute 5 second 6 subsecond

Returns:

date_timeを連想配列形式{timestamp, data,round_trip_time}で返す。dataにはCOREから直接送信されてきたdataviewが格納されている。round_trip_timeはデータを取得にかかった時間[ms]。

Type: 
Promise.<object>

(async) getDeviceInformation() → {Promise.<object>}

呼び出すと現在のデバイス設定を取得します。連想配列形式でリターンされます。asyncに対応させているので、awaitを利用して呼び出すことをおすすめします。

Returns:

device_informationを連想配列形式で返す

Type: 
Promise.<object>

gotAcc(acc)

加速度を取得する。加速度レンジに応じて変換された値がほしい場合は、gotConvertedAccを利用すること 対応CharacteristicはSENSOR_VALUES

Parameters:
NameTypeDescription
accObject

{x,y,z} 加速度の取得

gotBLEFrequency(frequency)

notification frequencyの実測値を取得する

Parameters:
NameTypeDescription
frequencyfloat

gotCalorie(calorie)

総消費カロリーを取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
calorieObject

{value}

gotConvertedAcc(acc)

コアモジュールで設定されている加速度レンジに応じて変換された値を取得する。 座標系は右手系(Z-up): Y=つま先方向, X=つま先方向に向かって右, Z=上(静止時 z≈+1G)。

Parameters:
NameTypeDescription
accObject

{x,y,z} 加速度レンジに応じて変換した加速度の取得

gotConvertedGyro(gyro)

ジャイロレンジに応じて変換された値を取得する。

Parameters:
NameTypeDescription
gyroObject

{x,y,z} ジャイロレンジに応じて変換したジャイロの取得

gotData(data)

ORPHE TERMINAL用に作成した関数。onReadで受け取ったデータをそのまま渡す。このメソッドがユーザ側でオーバーライドされると、その他のnotifyに伴うコールバック関数(gotAcc等)はすべて呼び出されなくなるので注意してください。dataview形式なので、取り扱い方法については ORPHE TERMINALのソースを参照するとよい。

Parameters:
NameTypeDescription
datadataview

onReadで取得したすべてのデータ

gotDelta(delta)

加速度値を2回積分して各x,y,zの単位時間の移動距離を取得する。

Parameters:
NameTypeDescription
deltaObject

{x,y,z} x,y,zの前回フレームからの移動距離

gotDirection(direction)

ランニングの方向を取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
directionObject

{value} 0:none, 1:foward, 2:backward, 3:inside, 4:outside

gotDistance(distance)

総移動距離を取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
distanceObject

{value}

gotEuler(euler)

コアモジュールのオイラー角を取得する。オイラー角の取得は破綻する可能性があるため、姿勢を取る場合はクオータニオンを利用すること

Parameters:
NameTypeDescription
eulerObject

{pitch, roll, yaw} オイラー角

gotFootAngle(foot_angle)

着地角度[degree]の取得(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
foot_angleObject

{value}

gotGait(gait)

歩容解析の取得(STEP_ANALYSIS FW対応待ちのため現状呼び出されません)

Parameters:
NameTypeDescription
gaitObject

{type, direction, calorie, distance} 歩行解析の取得

gotGyro(gyro)

ジャイロ(x,y,zの角速度)を取得する

Parameters:
NameTypeDescription
gyroObject

{x,y,z} ジャイロの取得

gotLandingImpact(landing_impact)

着地衝撃力[kgf/weight]の取得(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
landing_impactObject

{value}

gotPress(press)

コアモジュールの圧力情報を取得する。 values[i] は公式センサ番号 i+1 に対応する(1 つま先内側, 2 母趾球内側, 3 つま先外側, 4 中足部中央, 5 中足部外側, 6 踵)。配置図: https://orphe-oss.github.io/ORPHE-INSOLE.js/demo-app/#coords

Parameters:
NameTypeDescription
pressObject

{values[],timestamp,packet_number} 圧力の取得

gotPronation(pronation)

プロネーション[degree]の取得(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
pronationObject

{x,y,z}

gotQuat(quat)

コアモジュールのクオータニオン情報を取得する

Parameters:
NameTypeDescription
quatObject

{w,x,y,z} クオータニオンの取得

gotStandingPhaseDuration(standing_phase_duration)

立脚期継続時間[s]を取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
standing_phase_duration*

gotStatus(status)

Handles the received status.

Parameters:
NameTypeDescription
statusObject

The status object containing device advertisement information.

Properties
NameTypeDescription
namestring

デバイス名

rssinumber

受信信号強度 (dBm)

txPowernumber

送信出力 (dBm)

idstring

デバイスID

batterynumber

バッテリー残量

model_typenumber

モデルタイプ

mounting_positionnumber

取り付け位置

human_activity_recognitionnumber

人間活動認識

versionstring

ファームウェアバージョン (例: "1.2.3")

gotStepsNumber(steps_number)

現在までの歩数を取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
steps_numberObject

{value}

gotStride(stride)

ストライド[m]の取得(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
strideObject

{x,y,z}

gotSwingPhaseDuration(swing_phase_duration)

遊脚期継続時間[s]を取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
swing_phase_duration*

gotType(type)

現在の歩容タイプを取得する(STEP_ANALYSIS FW対応待ち)

Parameters:
NameTypeDescription
typeObject

{value} 0:none, 1:walk, 2:run, 3:stand

isGotDataOverridden()

gotData()がユーザ側でオーバーライドされているかどうかを返す関数です。これを見て,デバッグモード(ORPHE TERMINAL)を有効にするかどうかを判断します。オーバーライドするとgotData()以外の関数はコールバックされません.

lostData(serial_number, serial_number_prev)

以前来たデータとのシリアルナンバーの差が1でない場合に呼び出される。SENSOR_VALUESのcharacteristicを利用したリアルタイムデータ取得時に利用可能。

Parameters:
NameTypeDescription
serial_numbernumber

現在のシリアルナンバー

serial_number_prevnumber

一つ前に受診したデータのシリアルナンバー

onAdvertisement(event)

アドバタイズメントデータを受信した時に呼び出される

Parameters:
NameTypeDescription
eventBluetoothAdvertisingEvent

アドバタイズメントイベント

onAdvertisementReceived(event)

アドバタイズメントデータ受信時のコールバック

Parameters:
NameTypeDescription
eventBluetoothAdvertisingEvent

onRead(data, uuid)

Incoming byte callback function. コアモジュールから送信されるデータを受信するコールバック関数です。それぞれのUUIDに対応するデータを正しく整形して対応するコールバック関数に渡します。ユーザはコールバック関数を手元のコードでオーバーライドして利用します。gotData()がユーザによってオーバーライドされている場合は、gotData以外のnotifyに伴うコールバック関数はすべて呼び出されないことに注意してください。

Parameters:
NameTypeDescription
datadataView

incoming bytes

uuidstring

onReconnectAttempt(info)

自動再接続の試行開始時に呼び出される

Parameters:
NameTypeDescription
infoObject

{attempt, maxAttempts, intervalMs}

onReconnectFailed(info)

自動再接続が最大試行回数に達して失敗したときに呼び出される

Parameters:
NameTypeDescription
infoObject

{maxAttempts, elapsedMs, error}

onReconnectSuccess(info)

自動再接続成功時に呼び出される

Parameters:
NameTypeDescription
infoObject

{attempt, maxAttempts, elapsedMs, result}

read(uuid)

サーバからデータを読み込む。notificationからはonReadで呼び出されるので、この関数を利用するのは DEVICE_INFORMATION characteristicのみです。

Parameters:
NameTypeDescription
uuidstring

DEVICE_INFORMATION

requestDevice(uuid)

Execute requestDevice()

Parameters:
NameTypeDescription
uuidstring

reset()

reset(disconnect & clear) マニュアル切断の意思表示とみなし、自動再接続も無効化します。

resetAnalysisLogs()

Reset Analysis logs in the core module.

selectBluetoothDevice(uuid)

前回デバイスの記憶を使わず、必ずブラウザのBLE選択ダイアログを表示する。 接続済みINSOLEから別INSOLEへ手動で切り替える場合に利用する。

Parameters:
NameTypeDefaultDescription
uuidstringDEVICE_INFORMATION

(async) setDataStreamingMode(mode) → {Promise.<void>}

Sets the data streaming mode for the device.

Parameters:
NameTypeDefaultDescription
modenumber4

The streaming mode to set. Should be a valid mode value recognized by the device.

Returns:
Type: 
Promise.<void>

(async) setDateTime()

[YY, MM, DD, hh, mm, ss, (sub)ss]の配列を渡すことで、コアモジュールの日時設定ができます。

setDeviceInformation(obj)

this.device_informationの連想配列形式でデータを渡すことで、コアモジュールのデバイス設定ができます。 注意: ORPHE INSOLE の現行ファームウェアでは未対応です。

Parameters:
NameTypeDescription
objobject

setUUID(name, serviceUUID, characteristicUUID)

UUIDを設定する関数です。UUIDはsetup()で利用するキャラクタリスティック(DEVICE_INFORMATION, SENSOR_VALUES, STEP_ANALYSIS)の指定に利用されます。

Parameters:
NameTypeDescription
namestring
serviceUUIDstring
characteristicUUIDstring

setup(string[]opt, optionsopt)

最初に必要な初期化処理メソッドです。利用するキャラクタリスティック(DEVICE_INFORMATION, SENSOR_VALUES)の指定の他、オプションを指定することができます。通常利用では引数を省略して 今後の機能拡張を見据えたメソッドなので、基本的にはsetup()で呼び出せば良いです。

Parameters:
NameTypeAttributesDefaultDescription
string[]Array.<string><optional>
["DEVICE_INFORMATION","DATE_TIME", "SENSOR_VALUES"]

DEVICE_INFORMATION, DATE_TIME, SENSOR_VALUES,

optionsobject<optional>

初期化オプション

Properties
NameTypeAttributesDescription
interpolationobject<optional>

欠損補間オプション

Properties
NameTypeAttributesDefaultDescription
enabledboolean<optional>
false

線形補間の有効化/無効化

max_consecutive_missingnumber<optional>
1

線形補間する最大の連続欠損数

startNotify(uuid)

Start Notification

Parameters:
NameTypeDescription
uuidstring

startWatchingAdvertisements()

アドバタイズメントデータの監視を開始

stop()

stop and disconnect GATT connection

stopNotify(uuid)

Stop Notification

Parameters:
NameTypeDescription
uuidstring

stopWatchingAdvertisements()

アドバタイズメント監視を停止

(async) syncCoreTime(nopt) → {object}

COREモジュールの時刻を PCの時刻 + random_trip_time/2 で同期します。

Parameters:
NameTypeAttributesDefaultDescription
nnumber<optional>
3

n - 平均値算出のためのサンプル数

Returns:

{sum_round_trip_time, average_round_trip_time, standard_time, adjusted_time, round_trip_times}

Type: 
object

write(uuid, array_value)

write data to the BLE device。実際にwriteを利用するのは DEVICE_INFORMATION characteristicのみです。

Parameters:
NameTypeDescription
uuidstring

DEVICE_INFORMATION, SENSOR_VALUES, STEP_ANALYSIS

array_valuedataView

write bytes

(static) parseSensorValues(data, options) → {object|null}

SENSOR_VALUES の DataView を ORPHE INSOLE のサンプル列に変換する。

Parameters:
NameTypeDescription
dataDataView
optionsobject
Returns:
Type: 
object | null