applican

ビーコン情報設定ファイルについて

このファイルでは、端末が検出するビーコンの情報を設定できます。applican-config.xmlと同じディレクトリにbeacon-config.xmlという名前でファイルを配置します。ファイルの内容は以下のサンプルコードのような形になります。

サンプルコード

<?xml version="1.0" encoding="utf-8" ?>
<beacon-config>
	<beacons>
		<beacon uuid="00000000-ABCD-1234-ABCD-01234567">
			<local-notification>
				<retry-count>3</retry-count>
				<retry-interval-minutes>5</retry-interval-minutes>
				<reset-time>23:59</reset-time>
				<reset-interval-minutes>360</reset-interval-minutes>
				<conditions>
					<condition major="1">
						<monitoring-range-meters to="5" />
						<message lang="ja">検出１</message>
						<url>local://coupon1.html</url>
					</condition>
					<condition>
						<monitoring-range-meters from="10" to="15" />
						<message lang="ja">検出２</message>
						<url>local://coupon2.html</url>
					</condition>
				</conditions>
			</local-notification>
			<history>
				<max-history>100</max-history>
				<interval-seconds>60</interval-seconds>
				<expired-days>90</expired-days>
			</history>
		</beacon>
		<beacon uuid="11111111-BCDE-4567-BCDE-76543210" major="1" minor="2">
			<local-notification>
				<retry-count>3</retry-count>
				<retry-interval-minutes>2</retry-interval-minutes>
				<reset-time>23:59</reset-time>
				<reset-interval-minutes>10</reset-interval-minutes>
				<conditions>
					<condition>
						<monitoring-range-meters to="10" />
						<message lang="ja">検出３</message>
						<url>local://coupon.html</url>
					</condition>
				</conditions>
			</local-notification>
			<history>
				<max-history>100</max-history>
				<interval-seconds>30</interval-seconds>
				<expired-days>90</expired-days>
			</history>
		</beacon>
	</beacons>
</beacon-config>

beacon-configタグの中にbeaconsタグを準備し、その中にbeaconタグをネストしていくことで検出するビーコンの条件を追加できます。上記内容で検出されるビーコンは次の用になります。

タグの説明

タグの詳細説明は以下の通りとなります。

バックグラウンドで通知を行う方法

アプリがバックグラウンド状態にあるときに通知を行う方法を説明します。
通知を行うには、アプリインストール後にユーザにアプリを起動してもらう必要があります。その後アプリ内で以下のサンプルコードを実行しすることで、バックグラウンドでのビーコン監視が開始されます。
※アプリを開いた状態では通知されません。アプリを開いた応対でビーコン監視を行うには、次項の「アプリを開いた状態で通知を行う方法」をご確認ください。

サンプルコード

//　Beacon APIの初期化
applican.beacon.init(initBeaconSuccess, initBeaconError);

// 初期化成功
function initBeaconSuccess(){

	var dump = "initBeaconSuccess";
	console.log(dump);
	
	// 監視開始
	applican.beacon.startMonitoring(startMonitoringSuccess, startMonitoringError);
}

// 初期化失敗
function initBeaconError(errror){
	var dump = "beaconInitError\n";
	dump += "code:" + error.code + "\n";
	console.log(dump);
}

// 監視開始成功
function startMonitoringSuccess(){
	var dump = "startMonitoringSuccess";
	console.log(dump);
}

// 監視開始失敗
function startMonitoringError(error){
	var dump = "beaconInitError\n";
	dump += "code:" + error.code + "\n";
	console.log(dump);
}

アプリを開いた状態で通知を行う方法

アプリがバックグラウンド状態にあるときに通知を行う方法を説明します。
通知を行うには、アプリインストール後にユーザにアプリを起動してもらう必要があります。その後アプリ内で以下のサンプルコードを実行しすることで、バックグラウンドでのビーコン監視が開始されます。

サンプルコード

// 初期化成功
function initBeaconSuccess(){
	var dump = "initBeaconSuccess";
	console.log(dump);

	// 監視開始
	applican.beacon.startMonitoring(startMonitoringSuccess, startMonitoringError);

}

// 初期化失敗
function initBeaconError(errror){
	var dump = "beaconInitError\n";
	dump += "code:" + error.code + "\n";
	console.log(dump);
}

// 監視開始成功
function startMonitoringSuccess(){
	var dump = "startMonitoringSuccess";
	console.log(dump);
		
	// 監視するビーコンの情報
	var beaconInfo = { uuid:'00000000-1111-AAAA-BBBB-012345678901'};
	
	// アプリを開いた状態でビーコンの監視を開始。
	var watchId = applican.beacon.watchBeacon(beaconInfo, watchBeaconResult, watchBeaconSuccess, watchBeaconError);
}

// 監視開始失敗
function startMonitoringError(error){
	var dump = "beaconInitError\n";
	dump += "code:" + error.code + "\n";
	console.log(dump);
}
	
// 取得したビーコン情報。端末に依存しますがおよそ１秒ごとに取得されます。
function watchBeaconResult(beacon){
		
	console.log("watchBeaconResult");
	var uuid		= beacon.uuid;		// ビーコンの UUID
	var major		= beacon.major;		// ビーコンのメジャー番号
	var minor		= beacon.minor;		// ビーコンのマイナー番号
	var proximity	= beacon.proximity;	// 距離の精度（0:不明, 1:至近距離, 2:近距離, 3:遠距離）
	var accuracy	= beacon.accuracy;	// ビーコンまでの距離（メートル）
	var rssi		= beacon.rssi;		// 受信信号強度（dBm）
	var dump = "watchBeaconResult:\n";
	dump += "uuid : " + uuid + "\n";
	dump += "major : " + major + "\n";
	dump += "minor : " + minor + "\n";
	dump += "proximity : " + proximity + "\n";
	dump += "accuracy : " + accuracy + "\n";
	dump += "rssi : " + rssi + "\n";
	console.log(dump);
}

// アプリを開いた状態で監視開始成功
function watchBeaconSuccess(){
	var dump = "beaconWatchBeaconSuccess";
	console.log(dump);
}

// アプリを開いた状態で監視開始失敗
function watchBeaconError(error){
	var dump = "beaconWatchBeaconError\n";
	dump += "code:" + error.code + "\n";
	console.log(dump);
}