つくる、をつなぐProject Linking

LinkingコアライブラリAPI仕様書 for Android

ver 1.0.0
目次

センサーデータの取得

ControlSensorData

Linkingデバイス へセンサーデータの取得開始 停止依頼を行うクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

ControlSensorData(Context context, SensorDataInterface dataObserver)

デバイス検索の開始を通知します。
引数
Contextcontext送信者自身のコンテキスト
SensorDataInterfacedataObserverデータ受信を通知するためのコールバック関数の設定数の設定

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 setType センサータイプ情報の設定処理を行います。
2 setInterval センサー情報の取得間隔(ミリ秒単位)
3 setDuration 通知継続時間(秒単位)の設定処理を行います。
4 setBDaddress センサー情報を取得する機器のBDアドレス("00:11:22:AA:BB:CC"形式)の設定処理を行います。
5 setThreshold センサーの閾値を設定します。
6 setOriginalData 独自データを設定します。
7 start Linkingデバイスへセンサーデータの取得開始依頼を行います。
8 stop Linkingデバイスへセンサーデータの取得停止依頼を行います。
9 release リソース解放処理を行います。

メソッド詳細

setType
boolean setType(int type)
センサータイプ情報の設定処理を行います。
引数
inttypeセンサータイプ情報
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setInterval
boolean setInterval(int interval)
センサー情報の取得間隔(ミリ秒単位)
引数
intintervalセンサータイプ情報の取得間隔(ミリ秒単位)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setDuration
boolean setDuration(int duration)
通知継続時間(秒単位)の設定処理を行います。
・通知継続時間は最大86,400秒
・指定されなかった場合、86,400秒(24時間)を設定
引数
intduration通知継続時間(秒単位)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setBDaddress
boolean setBDaddress(String address)
センサー情報を取得する機器のBDアドレス("00:11:22:AA:BB:CC"形式)の設定処理を行います。
引数
Stringaddressセンサー情報を取得する機器のBDアドレス("00:11:22:AA:BB:CC"形式)
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setThreshold
boolean setThreshold(float xThreshold, float yThreshold, float zThreshold)
センサーの閾値を設定します。
引数
FloatxThresholdX軸閾値
FloatyThresholdY軸閾値
FloatzThresholdZ軸閾値
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
setOriginalData
boolean setOriginalData(byte[] originalData)
独自データを設定します。
引数
byte[]originalData独自データ
戻り値
true 正常終了
false パラメータ不正のため設定できませんでした
start
int start()
Linkingデバイスへセンサーデータの取得開始依頼を行います。
引数
なし
戻り値
アプリからの結果コードを参照してください。
stop
int stop()
Linkingデバイスへセンサーデータの取得停止依頼を行います。
本IFにより取得停止を行った場合にもonStopSensorにて通知されます。
引数
なし
戻り値
アプリからの結果コードを参照してください。
release
void release()
リソース解放処理を行います。
本IF使用終了時にこのメソッドを実行してください。
引数
なし
戻り値
なし

SensorDataInterface

データの受信を通知するためのコールバック

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 onStartSensorResult センサーデータ取得開始依頼の結果を通知するときに使用します。
2 onSensorData Linkingデバイスから取得したセンサーデータを通知するときに使用します。
3 onStopSensor センサーデータ取得停止を通知するときに使用します。

メソッド詳細

onStartSensorResult
void onStartSensorResult(String bd, int type, int reason)
センサーデータ取得開始依頼の結果を通知するときに使用します。
サービスアプリ側での関数内の実装が必要になります。
引数
Stringbdセンサー情報を取得する機器のBDアドレス("00:11:22:AA:BB:CC"形式)
inttypeセンサータイプ情報
intreasonアプリからの結果コード
戻り値
なし
onSensorData
void onSensorData(String bd, int type, float x, float y, float z, byte[] originalData, long time)
Linkingデバイスから取得したセンサーデータを通知するときに使用します。
Linkingデバイスからデータ受信時に、この関数がコールされます。
サービスアプリ側での関数内の実装が必要になります。
引数
Stringbdセンサー情報を取得した機器のBDアドレス("00:11:22:AA:BB:CC"形式)
inttypeセンサータイプ情報
FloatxX軸の値(IEEE754で定義された形式)
FloatyY軸の値(IEEE754で定義された形式)
FloatzZ軸の値(IEEE754で定義された形式)
byte[]originalData独自データ
longtime通知するセンサー情報の取得時刻(ミリ秒単位)
戻り値
なし
onStopSensor
void onStopSensor(String bd, int type, int reason)
センサーデータ取得停止を通知するときに使用します。
サービスアプリ側での関数内の実装が必要になります。
引数
Stringbdbdセンサー情報取得を停止する機器のBDアドレス("00:11:22:AA:BB:CC"形式)
inttypeセンサータイプ情報
longreasonアプリからの結果コード
戻り値
なし