# ORPHE-INSOLE.js Happy hacking for ORPHE INSOLE module on javascript. > [!CAUTION] > 現在ベータ版での提供です。細かなチュートリアルやドキュメントは整備中です。動作確認やフィードバックをお待ちしています。 ## 動作確認まずは手元のORPHE INSOLEを[sensor dashboard](https://orphe-oss.github.io/ORPHE-INSOLE.js/examples/sensor-dashboard)ページで接続し、値が取得できるかを確認してみましょう ## Getting Started 動作を確認できたら、以下のコードを利用して、ORPHE INSOLEの値を取得してみましょう。 ```javascript ORPHE INSOLE JS

Hello, ORPHE-INSOLE.js!

``` https://github.com/user-attachments/assets/209143e5-e53b-49f0-a1e5-10821334fa3a ### CDN ``` ``` `OrpheInsole` は `Orphe` と同じクラスを指す別名です。既存コードの `new Orphe(0)` は引き続き利用できます。 ### Tutorial * https://github.com/Orphe-OSS/ORPHE-INSOLE.js/wiki ### API Document * https://orphe-oss.github.io/ORPHE-INSOLE.js/docs/ ## Usage policy and commercial use ORPHE-INSOLE.js is developed as a JavaScript library for people using ORPHE INSOLE. Following the current ORPHE-CORE.js policy, ORPHE-INSOLE.js v1.0.0 and later is free to use, modify, and study for: * education and workshops * academic and non-commercial research * personal creative projects * prototypes and internal experiments * free apps and non-commercial services built with ORPHE INSOLE If you use ORPHE-INSOLE.js to build a paid app, paid service, commercial SDK integration, commissioned product, or business service, please contact ORPHE for a separate commercial agreement. This usage policy follows the ORPHE-CORE.js v1.4.0 and later policy for this repository. ## 利用方針と商用利用について ORPHE-INSOLE.js は、ORPHE INSOLEを使う人のためのJavaScriptライブラリです。現在のORPHE-CORE.jsの方針に従い、ORPHE-INSOLE.js v1.0.0以降では、以下の用途について、改変を含めて無償で利用できます。 * 教育・ワークショップ * 大学・研究機関などでの非商用研究 * 個人制作 * 試作・社内検証 * ORPHE INSOLEを使った無償アプリ・非商用サービス ORPHE-INSOLE.jsを使って、有料アプリ、有料サービス、商用SDK連携、受託開発、事業として提供するサービスを作る場合は、別途ORPHEとの商用契約が必要です。この利用方針は、ORPHE-CORE.js v1.4.0以降の利用方針をこのリポジトリで踏襲するものです。 ## 開発者向け情報 ### 環境構築必要なパッケージはnpmで事前にインストールしておきます。 ``` git clone https://github.com/Orphe-OSS/ORPHE-INSOLE.js.git cd ORPHE-INSOLE.js npm install ``` ### CDN用の圧縮ソースファイル生成圧縮ソースファイルは/dist以下に置きます。orphe-insole.min.jsを生成するには、以下のコマンドを実行してください。/dist 以下の圧縮されたorphe-insole.min.jsが保存されます。 ``` npm install terser --save-dev ``` ``` npm run build:min ``` ### APIドキュメント生成 ORPHE-INSOLE.jsのAPIドキュメントを生成するには、以下のコマンドを実行してください。ORPHE-INSOLE.jsファイルを直接jsdoc方式でコメントインして、以下のコマンドを実行するとdocs/にドキュメントが生成されます。jsdocの設定は、`jsdoc.json`に記述されています。ソースコードの変更があった場合に利用します。 ``` npm run generate-docs ``` ### テスト ``` npm test ``` `npm test` は SDK 本体、CoreToolkit、terminal example の構文チェックと、INSOLE の `SENSOR_VALUES` packet parser の Node.js テストを実行します。 ## BLE情報 characteristicに関しては、device information, update sensor values, date timeの3つのサービスを利用しています。これはORPHE COREと同じUUIDです。 * device information: 01a9d6b5-ff6e-444a-b266-0be75e85c064 * update sensor values: f3f9c7ce-46ee-4205-89ac-abe64e626c0f * date time: f53eeeb1-b2e8-492a-9673-10e0f1c29026 ### Device Information coreの時とは異なり、sensor_valuesの値を取得形式を変更する手段になっています。任意のデータをwriteすることで以下の通りのデータ形式になります。 * 0x0D,0x01：リアルタイムデータを取得（従来の200Hzデータ形式） * 0x0D,0x03: リアルタイム（ジャイロ、加速度、圧力）200Hz * 0x0D,0x04: リアルタイム（ジャイロ、加速度、圧力、クオータニオン）100Hz -- デフォルト `begin()` の第1引数に options object を渡すことで、接続開始時の送信形式を指定できます。 ``` insole.begin({ streamingMode: 4 }); // default: gyro, acc, pressure, quaternion at 100Hz insole.begin({ streamingMode: 3 }); // gyro, acc, pressure at 200Hz ``` ### Update Sensor Values センサーの値を更新するためのサービスです。device informationを通じてデータを送信すると、送信フォーマットを変更することができます。デフォルトでは0x0D,0x04の100Hzreal time送信になります。 ### Date Time センサから送信されてくるタイムスタンプ情報を同期するために利用します。ユーザサイドからの操作は基本的には不要です。 ## Requirements * float16.js, https://github.com/petamoriken/float16 * quaternion.js, https://github.com/infusion/Quaternion.js ## Copyright and licensing * Copyright (C) 2025, Tetsuaki BABA and ORPHE.inc. * See the usage policy above for ORPHE-INSOLE.js v1.0.0 and later.