Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (5.5%) to scientific vocabulary
Repository
Happy hacking for ORPHE CORE with python!!
Basic Info
- Host: GitHub
- Owner: Orphe-OSS
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://github.com/Orphe-OSS/ORPHE-CORE.py/wiki
- Size: 14.8 MB
Statistics
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
ORPHE-CORE.py
Happy hacking for ORPHE CORE with python!!
https://github.com/Orphe-OSS/ORPHE-CORE.py/assets/1846131/03c5f199-9a54-4307-a014-56b48d3ba373
Requirements
- Python 3.10 or later
Installation
bash
git clone https://github.com/Orphe-OSS/ORPHE-CORE.py.git
cd ORPHE-CORE.py
pip install bleak
動作確認
LEDを点滅させる
以下を実行して、センサデバイスのLEDが点滅することを確認してください。
終了する場合はCtrl+Cで終了できます。
bash
python blink_led.py
sensor valuesの値を取得する
加速度センサ、ジャイロセンサ、クオータニオンセンサの値を取得することができます。
以下を実行して、sensor valuesの値を取得することができます。
終了する場合はCtrl+Cで終了できます。
bash
python get_sensor_values.py
step analysisの値を取得する
以下を実行して、step analysisの値を取得することができます。
終了する場合はCtrl+Cで終了できます。
bash
python get_step_analysis.py
周りのBLEデバイスをスキャンする
コアモジュールを特定のデバイスに接続したい場合は、orphe.connect()の引数にデバイスのアドレスを指定することができます。これを利用するにあたって、特定のコアモジュールのアドレスを知りたい場合は以下を実行して周りのBLEデバイスをすべてスキャンすることができます。
bash
python scan.py
device informationを取得する
deviceinformation.py にコアモジュールの情報を取得するサンプルコードがあります。以下を実行して、コアモジュールの情報を取得することができます。 ```bash python deviceinformation.py ```
matplotlibを利用してデータを可視化する
https://github.com/user-attachments/assets/00990bf3-6367-4efe-9f6d-ec41de95cc93
plot_sensor_values.pyを実行することで、取得したセンサデータをmatplotlibを利用してリアルタイムに可視化することができます。初期設定では加速度値を可視化していますが、他のデータを可視化したい場合は適宜変更してください。
bash
pip install matplotlib
python plot_sensor_values.py
OSCでデータを送信する
osc.pyを実行することで、ORPHE COREから取得したデータをOSCで送信することができます。初期設定では5005番のポートに送信します。なおosc.pyは加速度値のみをoscで送信していますので、他のデータを送信したい場合は適宜変更してください。
bash
pip install python-osc
python osc.py
具体的なアプリケーション側での受信方法については OSCで様々なアプリケーションにデータをリアルタイム送信するを参照してください
GUIを利用してCOREと接続する
gui.pyにORPHE COREの接続や切断をgui上から実行できます。非常にシンプルなアプリケーションですが、coreの電波状況による接続解除や手動接続解除、バッテリーレベル表示等を実装しています。guiには tkinter というpythonの標準ライブラリを利用していますので、追加のインストールは不要です。フロントユーザレベルアプリケーション開発の参考にしてください。またOSCと組み合わせることで簡単なOSC送信アプリケーションも作成できます。
bash
python gui.py
ドキュメント
生成方法
orphecore.pyのdocstringからドキュメントを生成します。htmlファイルの生成には pdoc3 を利用しています。orphecore.pyのdocstringを書き換えたり、機能を追加した場合は以下のコマンドでドキュメントを再生成してください。
bash
pip install pdoc3
pdoc orphe_core --html -o docs/api --force
教材
wikiに学習教材や具体的なケーススタディをまとめています。このREADMEで基本的な使い方を学んだ後は、wikiを参照してさらに深く学ぶことができます。 * ORPHE-CORE.py学習教材
Compatibility
- ORPHE CORE 50Hz、200Hzモデルに対応していますが、50Hzモデルではsensor valuesにおける加速度、ジャイロ、クオータニオンのタイムスタンプやシリアル番号、パケット番号は利用することができません。これはファームウェアの仕様によるものです。
Owner
- Name: ORPHE Inc.
- Login: Orphe-OSS
- Kind: organization
- Email: mail@orphe.io
- Location: Japan
- Website: https://orphe.io/
- Twitter: orphe
- Repositories: 2
- Profile: https://github.com/Orphe-OSS
Open source softwares for ORPHE
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.0.0
title: ORPHE-CORE.py
message: >-
If you use this software or code, please cite it as
below
type: software
authors:
- given-names: Tetsuaki
family-names: Baba
email: baba@tmu.ac.jp
affiliation: Tokyo Metropolitan University
orcid: 'https://orcid.org/0000-0003-1792-881X'
version: 1.0.0-alpha.1
date-released: 2024-07-05
url: "https://github.com/Orphe-OSS/ORPHE-CORE.js"
GitHub Events
Total
- Push event: 6
- Gollum event: 73
- Fork event: 1
Last Year
- Push event: 6
- Gollum event: 73
- Fork event: 1