つくる、をつなぐProject Linking

Linking API 仕様書 for iOS

ver 3.0.4
目次

概要

はじめに

本ドキュメントではiOS Linking Library SDK( 以下、本ライブラリ )について記載をおこないます。

本ライブラリは以下の開発環境で作成および確認をおこなっています。
開発環境差異に依る影響を避けるため、本ライブラリを使用したiOSアプリケーションを開発する際には可能な限り環境をあわせることを推奨します。

iOS対応バージョンは9.1以上です。

参考資料

本ライブラリを使用するにあたっての参考資料一覧を以下に記載します。

表 参考資料一覧
項番仕様書名
1Linking API 仕様書 for iOS(本ページ)
2PeripheralDeviceLinkProfile_onBLE_Spec.pdf
3Linkingアドバタイズ情報フォーマット規定.pdf

用語

本ライブラリにおける関連用語の一覧を以下に記載します。

表 用語一覧
用語説明
BLEBluetooth Low Energy
CoreBluetoothiOS上のBLE用フレームワーク
LinkingデバイスLinking Libraryに対応したデバイス
PeripheralDeviceLinkProfileBLEを用いたLinkingデバイス連携用プロファイル
PropertyInformtionServicePeripheralDeviceLinkProfile上のプロパティ情報サービス
NotificationServicePeripheralDeviceLinkProfile上の通知サービス
SettingOperationServicePeripheralDeviceLinkProfile上の設定操作サービス
SensorInformationServicePeripheralDeviceLinkProfile上のセンサー情報サービス
OperationServicePeripheralDeviceLinkProfile上の操作サービス
サービスアプリ本ライブラリを組み込むiOSアプリケーション

SDK構成

サービスアプリ、Linkingデバイスとの関係性

本ライブラリの構成およびサービスアプリ、Linkingデバイスの関係性について以下に記載します。


図 ライブラリの構成およびサービスアプリ、Linkingデバイスの関係性

サービスアプリはLinkingライブラリを内包し実装されることを想定しています。
サービスアプリはLinkingライブラリを介することでPeripheralDeviceLinkProfileに対応したLinkingデバイスとの送受信が可能となります。

ライブラリ内部構成

本ライブラリの内部構成を以下に記載します。


図 ライブラリ内部構成

ライブラリバージョンの取得方法

本ライブラリのバージョンの取得方法を以下に記載します。

// ライブラリバージョンの取得
[BLECommonConsts versionInfo]