Orphe

Constructor

new Orphe(idopt)

初期化関数

Parameters:

Name	Type	Attributes	Default	Description
`id`	number	<optional>	0	id コアの番号（0 or 1）を指定します。

Properties

Name	Type	Description
`ORPHE_INFORMATION`	string	"01a9d6b5-ff6e-444a-b266-0be75e85c064" SERVICE_UUID
`ORPHE_DEVICE_INFORMATION`	string	"24354f22-1c46-430e-a4ab-a1eeabbcdfc0" CHARACTERISTIC_UUID
`ORPHE_OTHER_SERVICE`	string	"db1b7aca-cda5-4453-a49b-33a53d3f0833" SERVICE_UUID
`ORPHE_SENSOR_VALUES`	string	"f3f9c7ce-46ee-4205-89ac-abe64e626c0f" CHARACTERISTIC_UUID
`ORPHE_STEP_ANALYSIS`	string	"4eb776dc-cf99-4af7-b2d3-ad0f791a79dd" CHARACTERISTIC_UUID

Source: ORPHE-CORE.js, line 103

Members

acc

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

Properties

Name Type Description

acc

Object

加速度センサの値

Properties

Name	Type	Description
`x`	number	X軸方向の加速度センサの値
`y`	number	Y軸方向の加速度センサの値
`z`	number	Z軸方向の加速度センサの値

Source: ORPHE-CORE.js, line 261

converted_acc

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

Properties

Name Type Description

converted_acc

Object

加速度センサの値

Properties

Name	Type	Description
`x`	number	X軸方向の加速度センサの値
`y`	number	Y軸方向の加速度センサの値
`z`	number	Z軸方向の加速度センサの値

Source: ORPHE-CORE.js, line 283

converted_gyro

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

Properties

Name Type Description

converted_gyro

Object

ジャイロセンサの値

Properties

Name	Type	Description
`x`	number	X軸方向のジャイロセンサの値
`y`	number	Y軸方向のジャイロセンサの値
`z`	number	Z軸方向のジャイロセンサの値

Source: ORPHE-CORE.js, line 272

delta

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

Properties

Name Type Description

delta

Object

距離

Properties

Name	Type	Description
`x`	number	X軸方向の距離
`y`	number	Y軸方向の距離
`z`	number	Z軸方向の距離

Source: ORPHE-CORE.js, line 226

device_information

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

Properties

Name Type Description

device_information

Object

デバイス情報

Properties

Name Type Description

battery

number

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

lr

number

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

rec_mode

number

記録モード。記録してない, 記録中, 一時停止中：0, 1, 2

rec_auto_run

number

自動RUN記録　Off, On：0, 1

led_brightness

number

LEDの明るさ（0-255）

range

Object

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

Properties

Name	Type	Description
`acc`	number	加速度レンジ（ 2, 4, 8, 16(g)：0, 1, 2, 3）
`gyro`	number	ジャイロレンジ（250, 500, 1000, 2000(°/s)：0, 1, 2, 3）

Source: ORPHE-CORE.js, line 146

euler

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

Properties

Name Type Description

euler

Object

オイラー角

Properties

Name	Type	Description
`pitch`	number	ピッチ
`roll`	number	ロール
`yaw`	number	ヨー

Source: ORPHE-CORE.js, line 237

gait

歩容解析のデータを保存しておく連想配列です。

Properties

Name Type Description

gait

Object

歩容解析のデータ

Properties

Name	Type	Description
`type`	number	歩容のタイプ（0: 通常歩行, 1: 走行, 2: ランニング）
`direction`	number	歩容の向き（0: 前進, 1: 後退, 2: 左, 3: 右）
`calorie`	number	消費カロリー
`distance`	number	移動距離
`steps`	number	歩数
`standing_phase_duration`	number	立ち上がり時間
`swing_phase_duration`	number	振り出し時間

Source: ORPHE-CORE.js, line 159

gyro

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

Properties

Name Type Description

gyro

Object

ジャイロセンサの値

Properties

Name	Type	Description
`x`	number	X軸方向のジャイロセンサの値
`y`	number	Y軸方向のジャイロセンサの値
`z`	number	Z軸方向のジャイロセンサの値

Source: ORPHE-CORE.js, line 250

interpolation

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

Properties

Name Type Description

interpolation

Object

線形補間の設定

Properties

Name	Type	Description
`enabled`	boolean	線形補間の有効化/無効化　true: 有効, false: 無効
`max_consecutive_missing`	number	線形補間する最大の連続欠損数

Source: ORPHE-CORE.js, line 294

pronation

プロネーションのデータを保存しておく連想配列です。

Properties

Name Type Description

pronation

Object

プロネーションのデータ

Properties

Name	Type	Description
`landing_impact`	number	着地衝撃
`x`	number	X軸方向のプロネーション
`y`	number	Y軸方向のプロネーション
`z`	number	Z軸方向のプロネーション
`steps`	number	歩数

Source: ORPHE-CORE.js, line 194

quat

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

Properties

Name Type Description

quat

Object

クォータニオン

Properties

Name	Type	Description
`w`	number	w
`x`	number	x
`y`	number	y
`z`	number	z

Source: ORPHE-CORE.js, line 215

steps_number

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

Source: ORPHE-CORE.js, line 204

stride

ストライドのデータを保存しておく連想配列です。

Properties

Name Type Description

stride

Object

ストライドのデータ

Properties

Name	Type	Description
`foot_angle`	number	足首の角度
`x`	number	X軸方向のストライド
`y`	number	Y軸方向のストライド
`z`	number	Z軸方向のストライド
`steps`	number	歩数

Source: ORPHE-CORE.js, line 178

Methods

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

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

Parameters:

Name	Type	Attributes	Default	Description
`notification_type`	string	<optional>	"STEP_ANALYSIS"	STEP_ANALYSIS, SENSOR_VALUES, STEP_ANALYSIS_AND_SENSOR_VALUES
`options`	object	<optional>	{range:{acc:-1, gyro:-1}}	{range:{acc:[2,4,8,16],gyro:[250,500,1000,2000]}

Source: ORPHE-CORE.js, line 377

Returns:

Type:: Promise.<string>

clear()

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

Source: ORPHE-CORE.js, line 751

connectGATT(uuid)

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

Parameters:

Name	Type	Description
`uuid`	string

Source: ORPHE-CORE.js, line 538

dataChanged(self, uuid)

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

Parameters:

Name	Type	Description
`self`	function
`uuid`	string

Source: ORPHE-CORE.js, line 572

disconnect()

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

Source: ORPHE-CORE.js, line 680

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

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

Source: ORPHE-CORE.js, line 1159

Returns:

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

Type:: Promise.<object>

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

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

Source: ORPHE-CORE.js, line 1192

Returns:

device_informationを連想配列形式で返す

Type:: Promise.<object>

gotAcc(acc)

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

Parameters:

Name	Type	Description
`acc`	Object	{x,y,z} 加速度の取得

Source: ORPHE-CORE.js, line 1252

gotBLEFrequency(frequency)

notification frequencyの実測値を取得する

Parameters:

Name	Type	Description
`frequency`	float

Source: ORPHE-CORE.js, line 1357

gotCalorie(calorie)

総消費カロリーを取得する

Parameters:

Name	Type	Description
`calorie`	Object	{value}

Source: ORPHE-CORE.js, line 1292

gotConvertedAcc(acc)

コアモジュールで設定されている加速度レンジに応じて変換された値を取得する。

Parameters:

Name	Type	Description
`acc`	Object	{x,y,z} 加速度レンジに応じて変換した加速度の取得

Source: ORPHE-CORE.js, line 1262

gotConvertedGyro(gyro)

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

Parameters:

Name	Type	Description
`gyro`	Object	{x,y,z} ジャイロレンジに応じて変換したジャイロの取得

Source: ORPHE-CORE.js, line 1257

gotData(data)

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

Parameters:

Name	Type	Description
`data`	dataview	onReadで取得したすべてのデータ

Source: ORPHE-CORE.js, line 1235

gotDelta(delta)

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

Parameters:

Name	Type	Description
`delta`	Object	{x,y,z} x,y,zの前回フレームからの移動距離

Source: ORPHE-CORE.js, line 1267

gotDirection(direction)

ランニングの方向を取得する

Parameters:

Name	Type	Description
`direction`	Object	{value} 0:none, 1:foward, 2:backward, 3:inside, 4:outside

Source: ORPHE-CORE.js, line 1287

gotDistance(distance)

総移動距離を取得する

Parameters:

Name	Type	Description
`distance`	Object	{value}

Source: ORPHE-CORE.js, line 1298

gotEuler(euler)

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

Parameters:

Name	Type	Description
`euler`	Object	{pitch, roll, yaw} オイラー角

Source: ORPHE-CORE.js, line 1272

gotFootAngle(foot_angle)

着地角度[degree]の取得

Parameters:

Name	Type	Description
`foot_angle`	Object	{value}

Source: ORPHE-CORE.js, line 1320

gotGait(gait)

歩容解析の取得

Parameters:

Name	Type	Description
`gait`	Object	{type, direction, calorie, distance} 歩行解析の取得

Source: ORPHE-CORE.js, line 1277

gotGyro(gyro)

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

Parameters:

Name	Type	Description
`gyro`	Object	{x,y,z} ジャイロの取得

Source: ORPHE-CORE.js, line 1246

gotLandingImpact(landing_impact)

着地衝撃力[kgf/weight]の取得

Parameters:

Name	Type	Description
`landing_impact`	Object	{value}

Source: ORPHE-CORE.js, line 1331

gotPronation(pronation)

プロネーション[degree]の取得

Parameters:

Name	Type	Description
`pronation`	Object	{x,y,z}

Source: ORPHE-CORE.js, line 1326

gotQuat(quat)

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

Parameters:

Name	Type	Description
`quat`	Object	{w,x,y,z} クオータニオンの取得

Source: ORPHE-CORE.js, line 1241

gotStandingPhaseDuration(standing_phase_duration)

立脚期継続時間[s]を取得する

Parameters:

Name	Type	Description
`standing_phase_duration`	*

Source: ORPHE-CORE.js, line 1304

gotStepsNumber(steps_number)

現在までの歩数を取得する

Parameters:

Name	Type	Description
`steps_number`	Object	{value}

Source: ORPHE-CORE.js, line 1336

gotStride(stride)

ストライド[m]の取得

Parameters:

Name	Type	Description
`stride`	Object	{x,y,z}

Source: ORPHE-CORE.js, line 1315

gotSwingPhaseDuration(swing_phase_duration)

遊脚期継続時間[s]を取得する

Parameters:

Name	Type	Description
`swing_phase_duration`	*

Source: ORPHE-CORE.js, line 1310

gotType(type)

現在の歩容タイプを取得する

Parameters:

Name	Type	Description
`type`	Object	{value} 0:none, 1:walk, 2:run, 3:stand

Source: ORPHE-CORE.js, line 1282

isGotDataOverridden()

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

Source: ORPHE-CORE.js, line 317

lostData(serial_number, serial_number_prev)

以前来たデータとのシリアルナンバーの差が1でない場合に呼び出される。SENSOR_VALUESのcharacteristicを利用し、かつ、200Hzのデータ取得のモデル（CR-3）のみで利用可能。50Hzの加速度センサーのデータ取得モデル（CR-2）では利用できない。

Parameters:

Name	Type	Description
`serial_number`	number	現在のシリアルナンバー
`serial_number_prev`	number	一つ前に受診したデータのシリアルナンバー

Source: ORPHE-CORE.js, line 1343

onRead(data, uuid)

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

Parameters:

Name	Type	Description
`data`	dataView	incoming bytes
`uuid`	string

Source: ORPHE-CORE.js, line 775

read(uuid)

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

Parameters:

Name	Type	Description
`uuid`	string	DEVICE_INFORMATION

Source: ORPHE-CORE.js, line 582

requestDevice(uuid)

Execute requestDevice()

Parameters:

Name	Type	Description
`uuid`	string

Source: ORPHE-CORE.js, line 512

reset()

reset(disconnect & clear)

Source: ORPHE-CORE.js, line 759

resetAnalysisLogs()

Reset Analysis logs in the core module.

Source: ORPHE-CORE.js, line 497

resetMotionSensorAttitude()

Reset motion sensor attitude, quaternion culculation.

Source: ORPHE-CORE.js, line 490

(async) setDateTime()

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

Source: ORPHE-CORE.js, line 735

setDeviceInformation(obj)

this.device_informationの連想配列形式でデータを渡すことで、コアモジュールのデバイス設定ができます。

Parameters:

Name	Type	Description
`obj`	object

Source: ORPHE-CORE.js, line 699

setLED(on_off, pattern)

set LED mode

Parameters:

Name	Type	Description
`on_off`	int	0: turning off the LED, 1: turning on the LED
`pattern`	int	0-4

Source: ORPHE-CORE.js, line 475

setLEDBrightness(value)

sets the LED Brightness

Parameters:

Name	Type	Description
`value`	uint8	0-255, 0:turning off the LED

Source: ORPHE-CORE.js, line 483

setup(string[]opt, optionsopt)

最初に必要な初期化処理メソッドです。利用するキャラクタリスティック（DEVICE_INFORMATION, SENSOR_VALUES, STEP_ANALYSIS）の指定の他、オプションを指定することができます。オプションでは生データの取得を指定することができます。通常利用では引数を省略して setup() が呼び出されることが多いです。

Parameters:

Name	Type	Attributes	Default	Description
`string[]`	Array.<string>	<optional>	["DEVICE_INFORMATION", "SENSOR_VALUES", "STEP_ANALYSIS"]	DEVICE_INFORMATION, SENSOR_VALUES, STEP_ANALYSIS
`options`	object	<optional>	{interpolation}	interpolationは未実装

Source: ORPHE-CORE.js, line 336

setUUID(name, serviceUUID, characteristicUUID)

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

Parameters:

Name	Type	Description
`name`	string
`serviceUUID`	string
`characteristicUUID`	string

Source: ORPHE-CORE.js, line 327

startNotify(uuid)

Start Notification

Parameters:

Name	Type	Description
`uuid`	string

Source: ORPHE-CORE.js, line 621

stop()

stop and disconnect GATT connection

Source: ORPHE-CORE.js, line 466

stopNotify(uuid)

Stop Notification

Parameters:

Name	Type	Description
`uuid`	string

Source: ORPHE-CORE.js, line 640

(async) syncCoreTime(nopt) → {object}

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

Parameters:

Name	Type	Attributes	Default	Description
`n`	number	<optional>	3	n - 平均値算出のためのサンプル数

Source: ORPHE-CORE.js, line 710

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:

Name	Type	Description
`uuid`	string	DEVICE_INFORMATION, SENSOR_VALUES, STEP_ANALYSIS
`array_value`	dataView	write bytes

Source: ORPHE-CORE.js, line 600