ORPHE-INSOLE.js Documentation
ORPHE INSOLE(6ch圧力センサ + IMU 内蔵インソール型IoTセンサー)の JavaScript SDK ドキュメントです。
はじめに
- プロジェクト README — インストール・Getting Started・シミュレータの使い方
- API リファレンス(JSDoc) —
OrpheInsoleクラスの全メソッド・コールバック - CLAUDE.md — AI コーディングエージェント向けの包括的な実装ガイド(人間が読んでも有用)
リファレンス
| ドキュメント | 内容 |
|---|---|
| SENSOR_SPEC.md | パケットフォーマット(header 50/55/56)・単位系・mount_position ビット定義・チャネル配置とリマップ方針 |
| QUATERNION_FIX_VALIDATION.md | v1.2.1 クォータニオン修正の根拠・既存CSV救済手順・実機数値レポート様式 |
| TROUBLESHOOTING.md | 接続できない・データが来ない・再接続しない等の切り分け手順 |
| ai/PRESSURE_RECIPES.md | 圧力データ処理の実装パターン集(キャリブレーション・接地検出・CoP・可聴化) |
サンプル
実機がなくても OrpheInsoleSimulator(README の該当節参照)で大半のサンプルを確認できます。
| サンプル | 用途 |
|---|---|
| VISUALIZE | センサ可視化(推奨スターター) |
| showcase | 製品紹介が1ページで完結するショーケース(デモ再生つき) |
| sensor-dashboard | 2台同時ダッシュボード(L/R 自動マッピング) |
| balance-sway | 重心動揺の可視化 |
| balance-tuner | バランスの可聴化 |
| hula-motion-sonifier | 動作の可聴化(Web Audio) |
| device-test | 実機チェックリスト(リリース前検証用) |
| terminal | 生データデバッグ |
免責事項
本ライブラリおよびサンプルは医療機器ではなく、疾病の診断・治療・予防を目的としていません。 研究・教育・エンターテインメント用途を想定しています。
開発者向け
npm test # 構文チェック + 単体テスト + 型テスト
npm run lint # ESLint
npm run build # dist/ を生成(src 編集後は必須)
npm run generate-docs # この docs/ 配下の JSDoc を再生成
改善プロジェクトの計画は IMPROVEMENT_PLAN.md / CODEX_WORKPLAN.md を参照してください。