Eddystone と iOS - その2: 実装編

[その1](http://qiita.com/shu223/items/9ff648211af6554ebaf0) では iOS アプリ開発者から見た、Eddystone を採用するメリット・デメリットについて書きました。本記事は実装編として、**Core Bluetooth を用いた Eddystone 検出機能の実装方法** をポイントをかいつまんで紹介したいと思います。

![eddystone_logo.png](https://qiita-image-store.s3.amazonaws.com/0/3180/0ef6a6e1-b871-c706-4ef7-f0914c5bc273.png)


なお、本記事では Core Bluetooth や Bluetooth Low Energy の基礎的なことは省略します。よろしければ下記書籍を参考にしてください。

<div class="amazlet-box" style="margin-bottom:0px;"><div class="amazlet-image" style="float:left;margin:0px 12px 1px 0px;"><a href="http://www.amazon.co.jp/exec/obidos/ASIN/4883379736/22301-22/ref=nosim/" name="amazletlink" target="_blank"><img src="http://ecx.images-amazon.com/images/I/51XxjzdT%2BKL._SL160_.jpg" alt="iOS×BLE Core Bluetoothプログラミング" style="border: none;" /></a></div><div class="amazlet-info" style="line-height:120%; margin-bottom: 10px"><div class="amazlet-name" style="margin-bottom:10px;line-height:120%"><a href="http://www.amazon.co.jp/exec/obidos/ASIN/4883379736/22301-22/ref=nosim/" name="amazletlink" target="_blank">iOS×BLE Core Bluetoothプログラミング</a><div class="amazlet-powered-date" style="font-size:80%;margin-top:5px;line-height:120%">posted with <a href="http://www.amazlet.com/" title="amazlet" target="_blank">amazlet</a> at 15.03.23</div></div><div class="amazlet-detail">堤 修一 松村 礼央 <br />ソシム <br />売り上げランキング: 898<br /></div><div class="amazlet-sub-info" style="float: left;"><div class="amazlet-link" style="margin-top: 5px"><a href="http://www.amazon.co.jp/exec/obidos/ASIN/4883379736/22301-22/ref=nosim/" name="amazletlink" target="_blank">Amazon.co.jpで詳細を見る</a></div></div></div><div class="amazlet-footer" style="clear: left"></div></div>

（[電子書籍版](http://tatsu-zine.com/books/ios-ble-core-bluetooth-programming) もあります）


##Eddystone を発見する

普通に CBCentralManager でスキャンを開始するだけです。

```swift:swift
let services = [CBUUID(string: "FEAA")]
centralManager.scanForPeripheralsWithServices(services, options: nil)
```

上のコードでは Eddystone ビーコンだけを発見対象とするよう、Eddystone Service UUID `FEAA` を指定しています。

##アドバタイズメントデータから Eddystone フレームを取り出す

スキャンしてペリフェラル（ここではEddystoneビーコン）を発見すると、didDiscover〜が呼ばれるわけですが、この引数に入ってくるアドバタイズメントデータから [Eddystone frame](https://github.com/google/eddystone/blob/master/protocol-specification.md) を取り出します。

```swift:swift
func centralManager(
    central: CBCentralManager,
    didDiscoverPeripheral peripheral: CBPeripheral,
    advertisementData: [String : AnyObject],
    RSSI: NSNumber)
{
    let serviceData = advertisementData[CBAdvertisementDataServiceDataKey] as? [CBUUID : NSData]
    
    if let serviceData = serviceData {
        let eddystoneServiceData = serviceData[CBUUID(string: "FEAA")]
    }
}
```

こんな感じで、アドバタイズメントデータから `CBAdvertisementDataServiceDataKey` をキーとしてサービスデータを取り出し、その中からさらに Eddystone Service UUID をキーとして Eddystone フレームデータが取り出せます。


##フレームタイプを判別する

Eddystone フレームの先頭バイトが Eddystone のフレームタイプを示します。

```swift:swift
class func frameTypeForEddystoneServiceData(data: NSData) -> EddystoneFrameType {
    
    var bytes = [UInt8](count: data.length, repeatedValue: 0)
    data.getBytes(&bytes, length: data.length)
    let firstByte = bytes[0]
    
    if firstByte == 0x00 {
        return .UID
    }
    else if firstByte == 0x10 {
        return .URL
    }
    else if firstByte == 0x20 {
        return .TLM
    }
    return .Unknown
}
```

（Enum定義は省略）

こんな感じで、UID / URL / TLM を判別します。


##各フレームデータのパース

ここは細かい話になるので、詳細は割愛しますが、実装にあたっては下記のソースコードを参考にしました。

- [Google のサンプルコード](https://github.com/google/eddystone/tree/master/tools/ios-eddystone-scanner-sample)
  - 本家のコードなので仕様の解釈に困ったらこちらが指針になる
  - あくまでサンプル。あまり綺麗に、使い回しやすくは書かれていない。。
  - Eddystone-URLフレームタイプは非サポート（[Pull Request 送信済み](https://github.com/google/eddystone/pull/106)）

- [koutalou/BeaconRegionManager](https://github.com/koutalou/BeaconRegionManager)
  - 紹介記事：[Eddystone, iBeaconに対応したiOSライブラリを作った話](http://qiita.com/koutalou/items/3e144ecaef58ef0889c7)
  - Google のコードよりも整然と書かれていて読みやすい

##距離推定（近接度推定／レンジング）

iBeacon と同等に使おうと思うと、アドバタイズメントデータ受信時に呼ばれる `centralManager:didDiscoverPeripheral:advertisementData:RSSI:` の第4引数に入ってくる RSSI 値と、UID あるいは URL フレームに入っている TxPower より距離を推定するなり、RSSI 値を閾値処理して近い／遠い（iBeacon でいう Proximity）を判別するなりする必要があります。

これについては色々とあるのでまた別記事に書きたいと思います。


##バックグラウンドサポート

Eddystone向けの特別な手順は必要ありません。普通のセントラル側のバックグラウンド対応と同様です。詳しくは冒頭で紹介した参考書籍等をご参照ください。


##TLM / URL フレームの取り扱い

TLM / URL フレームは UID フレームと違って UUID/Major/Minor に相当するような**「ビーコンを特定するデータ」を持っていません**。が、たとえばTLMフレームからメンテナンス用の情報を取得できたとして、「**このTLMデータはどのビーコンのものなの？**」というのを解決しないと意味がありません。

ではどうするのかというと、**ペリフェラルの UUID を用いて UID フレームと紐付け**ます。

TLM フレームは [Frame Specification](https://github.com/google/eddystone/tree/master/eddystone-tlm) に書かれている通り、UID や URL フレームの合間にアドバタイズされるものなので、

- UIDフレームデータを保持するモデルクラスに、TLMデータを保持できるようプロパティを用意しておく

```objc:objc
@interface EddystoneUIDBeacon : EddystoneBeacon

@property (nonatomic) NSNumber *txPower;
@property (nonatomic) NSString *namespaceId;
@property (nonatomic) NSString *instanceId;

@property (nonatomic) EddystoneTLMBeacon *tlmBeacon;

@end
```

- UIDフレームが検出されたら、ペリフェラルUUIDをキーとして、UIDフレームデータをDictionaryに保持する

```swift:swift
beaconDic[beacon.identifier] = foundBeacon
```

- TLMフレームが検出されたら、ペリフェラルUUIDをキーとして上記Dictionaryの値を取り出し、値（＝UIDフレームデータ）があればそのプロパティにTLMデータをセットする

```swift:swift
foundBeacon = beaconDic[beacon.identifier]
foundBeacon.tlmBeacon = beacon
```

といった感じで実装できます。


じゃあURLの場合はどうするのかというと、Googleのサンプルには実装されていなかったので、正式なところはよくわかりません。URLにID的なものを持たせられる、という考え方なのかもしれません。

が、自分が今回試していた kontakt.io のビーコンでは、**UID/URL/TLMの3パケットを順番にアドバタイズする**（設定切り替えによってではなく）という挙動だったので、TLM同様ペリフェラルUUIDを用いてUIDフレームと紐付ける、という実装を行いました。（[Google に送った Pull Request](https://github.com/google/eddystone/pull/106) もそういう実装）


##まとめ

今回は実装編として、Eddystone ビーコンを iOS アプリから検出する際の実装方法をポイントをかいつまんで紹介しました。Eddystone は [Bluetooth SIG に承認されないと使用できない16ビットUUID](https://www.bluetooth.org/ja-jp/Pages/16-bit-UUID.aspx) を持っているとか、TLMはUID/URLフレームの合間にアドバタイズされるものであるとか、TLMフレームはUIDフレームと紐付けて用いるとか、（今回は書きませんでしたが）URLを20バイト以内（実質18バイト以内）にどう収めているか等々、個人的には**実装してみるまでは見過ごしていた仕様**が多々ありました。今回割愛した、「RSSIからの距離あるいは近接度推定」についてはiBeaconと共通の話でもあるので、また別記事で書きたいと思います。

（追記）書きました： [RSSI と TxPower からビーコンとの距離および近接度（Proximity）を推定する](http://qiita.com/shu223/items/7c4e87c47eca65724305)