つくる、をつなぐProject Linking

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

ver 1.0.0
目次

ビーコンの受信

BeaconScanner

ビーコンスキャン開始停止依頼を行うクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

BeaconScanner()

引数
Contextcontext送信者自身のcontext

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 startScan ビーコンの定期的なスキャン開始を依頼するときに使用します。
2 startScan ビーコンスキャンの周期間隔モード(スキャンモード)を指定することが可能です。
3 stopScan ビーコンスキャン停止

メソッド詳細

startScan
void startScan(int[] serviceIds)
ビーコンの定期的なスキャン開始を依頼するときに使用します。
ビーコンスキャンの周期間隔モード(スキャンモード)を指定する場合は、startScan(int[] serviceIds, int scanMode)をご利用ください。
スキャン開始依頼後、定期的にスキャンを実行し、ビーコンが検出された場合にはビーコンスキャン結果通知にて通知されます。
スキャン開始依頼後、スキャン状態が変化する都度、ビーコンスキャン状態通知にて通知されます。
引数
int[]serviceIdsビーコンサービスID(複数指定可)
戻り値
なし
startScan
void startScan(int[] serviceIds, int scanMode)
ビーコンの定期的なスキャン開始を依頼するときに使用します。
ビーコンスキャンの周期間隔モード(スキャンモード)を指定することが可能です。
スキャン開始依頼後、定期的にスキャンを実行し、ビーコンが検出された場合にはビーコンスキャン結果通知にて通知されます。
スキャン開始依頼後、スキャン状態が変化する都度、ビーコンスキャン状態通知にて通知されます。
引数
int[]serviceIdsビーコンサービスID(複数指定可)
intscanModeスキャンモード
戻り値
なし
stopScan
void stopScan()
ビーコンスキャン停止
引数
なし
戻り値
なし

BeaconData

ビーコンスキャンデータが格納されています。
ビーコン情報通知にてビーコンスキャン結果として通知されるデータです。
ビーコンスキャン結果として取得された各種情報が格納されており、それらを取得する際に使用します。

パッケージ

com.example.projectlinking.android.LinkingLibrary

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 getTimeStamp ビーコン情報の検出時刻(ミリ秒)を取得します。
2 getAddress ビーコン機器のBDアドレス(“00:11:22:AA:BB:CC”形式)を取得します。
3 getVendorId ベンダ識別子を取得します。
4 getExtraId 個別番号を取得します。
5 getRssi SSI値(dBm)を取得します。
6 getVersion バージョンを取得します。
7 getDistance 距離種別を取得します。
8 getTxPower Txパワー(dBm)を取得します。
9 isServiceDataEncrypted T.B.D
10 getTemperature 温度(℃)を取得します(ビーコンサービスID「1」のデータ)
11 getHumidity 湿度(%)を取得します(ビーコンサービスID「2」のデータ)
12 getAtmosphericPressure 気圧(hPa)を取得します(ビーコンサービスID「3」のデータ)
13 getLowBattery 電池残量低下(要充電)フラグを取得します(ビーコンサービスID「4」のデータその1)
14 getBatteryPower 電池残量(%)を取得します(ビーコンサービスID「4」のデータその2)
15 getButtonId ボタン識別子を取得します(ビーコンサービスID「5」のデータ)
16 getOpenCloseSensor 開閉センサー情報を取得します(ビーコンサービスID「6」のデータ)
17 getHumanSensor 人感センサー情報を取得します(ビーコンサービスID「7」のデータ)
18 getRawData8 振動センサー情報を取得します(ビーコンサービスID「8」のデータ)
19 getRawData9 Rawデータを取得します(ビーコンサービスID「9」のデータ)
20 getRawData10 Rawデータを取得します(ビーコンサービスID「10」のデータ
21 getRawData11 Rawデータを取得します(ビーコンサービスID「11」のデータ)
22 getRawData12 Rawデータを取得します(ビーコンサービスID「12のデータ)
23 getRawData13 Rawデータを取得します(ビーコンサービスID「13のデータ)
24 getRawData Rawデータを取得します(ビーコンサービスID「15」のデータ)

メソッド詳細

getTimeStamp
long getTimeStamp()
ビーコン情報の検出時刻(ミリ秒)を取得します。
引数
なし
戻り値
null 情報なし
null以外ビーコン機器のBDアドレス(“00:11:22:AA:BB:CC”形式)
getAddress
String getAddress()
ビーコン機器のBDアドレス(“00:11:22:AA:BB:CC”形式)を取得します。
引数
なし
戻り値
null 情報なし
null以外ビーコン機器のBDアドレス(“00:11:22:AA:BB:CC”形式)
getVendorId
int getVendorId()
ベンダ識別子を取得します。
引数
なし
戻り値
null 情報なし
null以外ベンダ識別子
getExtraId
int getExtraId()
個別番号を取得します。
引数
なし
戻り値
null 情報なし
null以外個別番号
getRssi
int getRssi()
RSSI値(dBm)を取得します。
引数
なし
戻り値
RSSI値(dBm) -128~127
getVersion
int getVersion()
バージョンを取得します。
引数
なし
戻り値
ビーコンサービスのバージョン
getDistance
Integer getDistance()
距離種別を取得します。
引数
なし
戻り値
null 情報なし
null以外距離種別
getTxPower
Integer getTxPower()
Txパワー(dBm)を取得します。
引数
なし
戻り値
null 情報なし
null以外Txパワー(dBm) -127~127
isServiceDataEncrypted
boolean isServiceDataEncrypted()
T.B.D
引数
なし
戻り値
getTemperature
Float getTemperature()
温度(℃)を取得します(ビーコンサービスID「1」のデータ)
引数
なし
戻り値
null 情報なし
null以外温度(℃) -255.0~255.0
getHumidity
Float getHumidity()
湿度(%)を取得します(ビーコンサービスID「2」のデータ)
引数
なし
戻り値
null 情報なし
null以外湿度(%) 0.0~255.5
getAtmosphericPressure
Float getAtmosphericPressure()
気圧(hPa)を取得します(ビーコンサービスID「3」のデータ)
引数
なし
戻り値
null 情報なし
null以外気圧(hPa) 0.0~65280.0
getLowBattery
boolean getLowBattery()
電池残量低下(要充電)フラグを取得します(ビーコンサービスID「4」のデータその1)
引数
なし
戻り値
null 情報なし
null以外電池残量低下(要充電)フラグ
getBatteryPower
Float getBatteryPower()
電池残量(%)を取得します(ビーコンサービスID「4」のデータその2)
引数
なし
戻り値
null 情報なし
null以外電池残量(%) 0.0~100.0
getButtonId
Integer getButtonId()
ボタン識別子を取得します(ビーコンサービスID「5」のデータ)
引数
なし
戻り値
null 情報なし
null以外押下されたボタン識別子
getOpenCloseSensor
Integer getOpenCloseSensor()
開閉センサー情報を取得します(ビーコンサービスID「6」のデータ)
引数
なし
戻り値
null 情報なし
null以外開閉センサー情報
getHumanSensor
Integer getHumanSensor()
人感センサー情報を取得します(ビーコンサービスID「7」のデータ)
引数
なし
戻り値
null 情報なし
null以外人感センサー情報
getRawData8
Integer getRawData8()
振動センサー情報を取得します(ビーコンサービスID「8」のデータ)
引数
なし
戻り値
null 情報なし
null以外振動センサー情報
getRawData9
Integer getRawData9()
Rawデータを取得します(ビーコンサービスID「9」のデータ)
引数
なし
戻り値
null 情報なし
null以外Rawデータ(下位12bitが有効、残りのbitは0)
getRawData10
Integer getRawData10()
Rawデータを取得します(ビーコンサービスID「10」のデータ)
引数
なし
戻り値
null 情報なし
null以外Rawデータ(下位12bitが有効、残りのbitは0)
getRawData11
Integer getRawData11()
Rawデータを取得します(ビーコンサービスID「11」のデータ)
引数
なし
戻り値
null 情報なし
null以外Rawデータ(下位12bitが有効、残りのbitは0)
getRawData12
Integer getRawData12()
Rawデータを取得します(ビーコンサービスID「12」のデータ)
引数
なし
戻り値
null 情報なし
null以外Rawデータ(下位12bitが有効、残りのbitは0)
getRawData13
Integer getRawData13()
Rawデータを取得します(ビーコンサービスID「13」のデータ)
引数
なし
戻り値
null 情報なし
null以外Rawデータ(下位12bitが有効、残りのbitは0)
getRawData
Integer getRawData()
Rawデータを取得します(ビーコンサービスID「15」のデータ)
引数
なし
戻り値
null 情報なし
null以外Rawデータ(下位12bitが有効、残りのbitは0)

BeaconCalibration

ビーコンでの距離の調整開始依頼を行うクラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

BeaconCalibration(Context context)

デバイス検索の開始を通知します。
引数
Contextcontext送信者自身のcontext
戻り値
なし

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 startCalibration ビーコンでの距離の調整開始依頼を行います。

メソッド詳細

startCalibration
void startCalibration(int vendorId, int extraId)
ビーコンでの距離の調整開始依頼を行います。
引数
IntvendorId対象デバイスのベンダ識別子
IntextraId対象デバイスの個別番号
戻り値
なし

BeaconReceiverBase

ビーコン情報通知を受け取る基底クラス

パッケージ

com.example.projectlinking.android.LinkingLibrary

コンストラクタ

BeaconReceiverBase

引数
なし

メソッド一覧

publicメソッド一覧

NO メソッド名 概要
1 onReceiveScanResult 検出されたビーコンのデータが通知されます。
2 onReceiveScanState ビーコンスキャン状態が変化した際に通知されます。
3 onReceiveCalibrationResult ビーコンでの距離の調整結果が通知されます。

メソッド詳細

onReceiveScanResult
void onReceiveScanResult(BeaconData data)
検出されたビーコンのデータが通知されます
引数
BeaconDatadataビーコンスキャンデータ
戻り値
なし
onReceiveScanState
void onReceiveScanState(int scanState, int detail)
ビーコンスキャン状態が変化した際に通知されます
引数
IntscanStateスキャン状態
intdetail詳細コード
戻り値
なし
onReceiveCalibrationResult
void onReceiveCalibrationResult(int result)
ビーコンでの距離の調整結果が通知されます
引数
Intresult距離調整結果
戻り値
なし