つくる、をつなぐProject Linking

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

ver 1.0.0
目次

デバイスの接続

LinkingDevice

Linkingデバイスとの接続や切断を提供するクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

LinkingDevice(Context context, String bdaddress, String name)

引数
Contextcontextアプリケーションのコンテキスト
StringbdaddresssBDデバイスアドレス("00:11:22:AA:BB:CC"形式)
Stringnameデバイス名

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 connect デバイスに接続します。
2 disconnect デバイスと切断します。
3 getBdaddress デバイスアドレスを取得します。
4 getName デバイス名を取得します。
5 startCalibration キャリブレーションを開始します。
6 cancelCalibration キャリブレーションを中止します。

メソッド詳細

connect
boolean connect()
Linkingデバイスに接続します。(接続通知(connectInterface#onConnect()))
引数
なし
戻り値
実行結果(true:成功/ false:失敗)
disconnect
boolean disconnect()
デバイスと切断します。(切断通知(connectInterface#onDisconnect())
引数
なし
戻り値
実行結果(true:成功/ false:失敗)
getBdaddress
String getBdaddress()
デバイスアドレスを取得します。
引数
なし
戻り値
デバイスアドレス
getName
String getName()
デバイス名を取得します。
引数
なし
戻り値
デバイス名
startCalibration
boolean startCalibration(LinkingDevice.CalibrationCallback callback)
キャリブレーションを開始します。
引数
LinkingDevice.CalibrationCallbackcallbackキャリブレーション結果通知コールバック
戻り値
実行結果(true:成功/ false:失敗)
cancelCalibration
boolean cancelCalibration(LinkingDevice.CalibrationCallback callback)
キャリブレーションを中止します。
引数
LinkingDevice.CalibrationCallbackcallbackキャリブレーション結果通知コールバック
戻り値
実行結果(true:成功/ false:失敗)

CalibrationCallback

キャリブレーション結果通知。

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 onCalibrationSuccess キャリブレーションが成功したことを通知します。
2 onCalibrationFailed キャリブレーションが失敗したことを通知します。

メソッド詳細

onCalibrationSuccess
void onCalibrationSuccess()
キャリブレーションが成功したことを通知します。
引数
なし
戻り値
なし
onCalibrationFailed
void onCalibrationFailed()
キャリブレーションが失敗したことを通知します。
引数
なし
戻り値
なし

NotifyConnect

LinkingアプリとLinkingデバイスの接続/切断が変更したことを受信するクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

NotifyConnect(Context context, ConnectInterface observer)

デバイス検索の開始を通知します。
引数
Contextcontext送信者自身のcontext
ConnectInterfaceobserverデータの受信を通知するためのコールバック関数

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 release リソース解放処理を行います。

メソッド詳細

release
void release()
リソース解放処理を行います。
本IF使用終了時に(onDestroy()など)このメソッドを実行してください。
引数
なし
戻り値
なし

NotifyConnect. ConnectInterface

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

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 onConnect LinkingアプリがLinkingデバイスと接続したことを通知します。
2 onConnectFail Linkingアプリが周辺機器と接続に失敗したことを通知します。
3 onDisconnect LinkingアプリがLinkingデバイスと切断したことを通知します。

メソッド詳細

onConnect
void onConnect(String name,int deviceID, int deviceUID, String bdaddress,int connection, int capability, int exSensorType)
LinkingアプリがLinkingデバイスと接続したことを通知します。
サービスアプリ側での関数内の実装が必要になります。
引数
Stringnameデバイスの名称
intdeviceIDデバイスID
intdeviceUIDデバイス固有ID
StringbdaddressBDアドレス("00:11:22:AA:BB:CC"形式)
intconnection接続種別
intcapabilityデバイスの能力
intexSensorTypeデバイスの拡張センサータイプ情報
戻り値
なし
onConnectFail
void onConnectFail(String bdaddress)
Linkingアプリが周辺機器と接続に失敗したことを通知します。
サービスアプリ側での関数内の実装が必要になります。
引数
StringbdaddressBDアドレス("00:11:22:AA:BB:CC"形式)Int
戻り値
なし
onDisconnect
void onDisconnect(String name, int deviceID, int deviceUID)
LinkingアプリがLinkingデバイスと切断したことを通知します。
サービスアプリ側での関数内の実装が必要になります。
引数
Stringnameデバイスの名称
intdeviceIDデバイスID
intdeviceUIDデバイス固有ID
戻り値
なし