ORPHE CORE JS

Happy hacking for ORPHE CORE module on javascript.

Please go to the github page for document and Demos. ドキュメントとデモはgithubページをご覧ください。

Please go to the github page for tutorial. チュートリアルはgithubページをご覧ください。

Version

機能追加でマイナーバージョンアップを行います。バグフィックスやリファクタリングはパッチバージョンアップとします。

• v1.3: Date Timeキャラクタリスティック対応
  • COREモジュールの時刻を取得，設定する setDateTime(), getDateTime() を追加しました。この機能を利用して，begin()メソッドを利用した際に必ず最初にコアモジュールの時刻合わせが実行されます．PCの現在時刻にgetDateTime()にかかった時間の1/2を加算して，コアモジュールに時刻設定します．ただしgetDataTime()は3回取得し，その取得時間平均値/2としています．
• v1.2: ES6 class based version.
  • プロトタイプだけでなく、プロダクトとして利用されることが多くなったため、本格的なリファクタリングを行いました。ES6のクラスベースの構造に変更し、より理解しやすく読みやすいコードになりました。v1.1互換なので、従来どおりの記述でコアモジュールにアクセスできます。
• v1.1: bug fixes, last update 29th/May/2024
  • 最初のリリースからシステムの安定性、バグフックス、最低限必要な機能追加などを継続してきました。いくつかのアプリケーション等でも利用されるようになりました。生データを取得可能な gotData() が利用可能となりました。"RAW", "ANALYSIS"としていたコア内での名称をCharacteristicsと同じ"SENSOR_VALUES"、"STEP_ANALYSIS"に統一しました。
• v1.0: First release on 13rd/Sep/2022
  • 最初のリリース（https://orphe.io/news/orphe-releases-orphe-core-javascript-library）このversionではブランチを切っていません。

開発者向け情報

ブランチ

開発用は dev ブランチを利用します。

環境構築

Node.jsのインストール後、以下のコマンドを実行して環境を構築してください。

npm install

jsdocのドキュメント生成

ORPHE-CORE.jsのAPIドキュメントを生成するには、以下のコマンドを実行してください。ORPHE-CORE.jsファイルを直接jsdoc方式でコメントインして、以下のコマンドを実行するとapi_docにドキュメントが生成されます。jsdocの設定は、jsdoc.jsonに記述されています。

npm run generate-docs

Requirements

• float16.js, https://github.com/petamoriken/float16
• quaternion.js, https://github.com/infusion/Quaternion.js

Acknowledgments

API Document page is generated by jsdoc and clearn jsdoc theme.

Copyright and licensing

• Copyright (C) 2022-2024, Tetsuaki BABA and ORPHE.inc under the MIT License.