ビーコンスキャンSDK

# MinewBeacon スキャン ソフトウェア開発キット ガイド

## インストール

### CocoaPods

MinewBeaconScan is available through [ココアポッド](http://ココアポッド.org/). インストールするには, 次の行を Podfile に追加するだけです, そしてインポートします <MinewBeaconScan>:

### 手動で

1.  プロジェクトをダウンロードし、MinewBeaconScan.framework フォルダーをプロジェクトにドロップします。.
2.  ファイルをインポートする `<MinewBeaconScan>`.

```c
#import <MinewBeaconScan>
「」

## Requirements

This library requires iOS 9.0+.

## Configs before development

The SDK used CoreLocation and CoreBluetooth.

Appleの監査仕様に準拠するため, バックグラウンドタスクを使用するかどうかを区別する必要があります.

開発者にとってバックグラウンドタスクは必要ありません:

「」c
  // 1. 背景サポートを NO に設定します 
    [aManager startScan:uuids 背景サポート: いいえ];

// 2. 位置情報の更新を無効にし、プロジェクトで Bluetooth LE アクセサリを使用します.

//  PS: iOSの制限があるため, 一部のデバイスがバックグラウンド スキャンをサポートしていない場合, アプリがバックグラウンドになると、デバイスのこれらのデータは取得されません, アプリケーションプロセスは一時停止状態ではありませんが、.
```

for the developer require background task：

「」c
  // 1. 背景サポートをYESに設定します
  [aManager startScan:uuids 背景サポート :はい];
   
  // 2、位置情報の更新と Bluetooth LE アクセサリの使用を同時に有効にします。, 追加する必要があります "NSLocationAlwaysUsageDescription" プロジェクトの info.plist ファイルに項目を追加します.

// PS：SDK はバックグラウンド モードに変更され、スキャンを続行します。,バックグラウンドモードをサポートするデバイスがある場合, すべてのデリゲート メソッドは通常どおり実行されます.
```

Configs for "info.plist"

「」c
   
<key>NSBluetooth周辺機器の使用法説明</key> 
<string>アプリは Bluetooth を使用してデバイスと通信します.</string> 
   
<key>NS場所の使用法説明</key> 
<string>アプリはあなたの位置を記録します</string> 
 
<key>NSLocationWhenInUseUsageDescription</key> 
<string>アプリはあなたの位置を記録します</string> 
  

 
<key>NSLocationAlwaysUsageDescription</key> 
<string>アプリはあなたの位置を記録します</string> 
「」

## Get Started

MinewBeaconManager (以下のマネージャーとして) 周囲のデバイスをスキャンまたは停止できます, **Minewbeacon** が作成されます(以下のビーコンとして) すべてのデバイスのインスタンス. データの更新をリッスンして表示されます(数秒以内にデータが更新されない場合、デバイスが消失したと考えられます, デバイスが最初にスキャンされたか、最初からスキャンされた場合、デバイスが出現したと考えられます。 "消える" ) デバイスの状態, 同時に, マネージャーは携帯電話の Bluetooth 状態の変化をリッスンします. 以下のコードです:

1.  マネージャー共有インスタンスを取得する, デリゲートを設定する:

```c
MinewBeaconManager *manager = [MinnewBeaconManager 共有インスタンス];
マネージャー.デリゲート = 自分自身;
「」

2.  デバイスのスキャンを開始する.

「」c
[マネージャースタートスキャン:@[@"uuid1", @"uuid2",...] 背景サポート:いいえ];
「」

3.  デリゲートメソッドからデバイスのデータを取得する.

「」c
// マネージャーがデバイスを見つけた場合, このメソッドは毎秒実行されます, 
- (空所)mynewBeaconManager:(MinnewBeaconManager *)マネージャーがやったレンジビーコン:(NSArray<MinewBeacon *> *)ビーコン
{
    NSLog(@"現在のビーコン:%@", ビーコン);
}
「」

4.  ビーコンインスタンスのデータを取得する.
    
    ビア方式 "-(MinnewBeaconValue \*)getBeaconValue:(ビーコン値インデックス)索引". データの汎用性を高めるために, **MinewBeaconValue** を使用してあらゆる種類のデータを処理します, BeaconValue インスタンスは文字列にすることができます, 整数, float または bool, 毎 "索引" 値に対応する, 以下のコードのように:

```c
MinewBeacon *beacon = beacons[0];

// uuid
NSString *uuid = [ビーコンgetBeaconValue:BeaconValueIndex_UUID].文字列値; 
// major
NSInteger major = (長さ)[ビーコンgetBeaconValue:BeaconValueIndex_Major].intValue;
// minor
NSInteger minor = (長さ)[ビーコンgetBeaconValue:BeaconValueIndex_Minor].intValue;
```

Table for ValueIndex and data types

| 索引 | データ名 | タイプ | 詳細 |
| --- | --- | --- | --- |
| ビーコン値インデックス_UUID | uuid | 文字列値 |  |
| ビーコン値インデックス_名前 | 名前 | 文字列値 |  |
| BeaconValueIndex_Major | 選考科目 | intValue |  |
| BeaconValueIndex_Minor | マイナー | intValue |  |
| BeaconValueIndex_WechatId | wechatId | intValue | 部分的なデバイス |
| BeaconValueIndex_Mac | MACアドレス | 文字列値 | 部分的なデバイス |
| ビーコン値インデックス_RSSI | RSSI | intValue |  |
| ビーコン値インデックス_バッテリーレベル | バッテリー | intValue |  |
| ビーコン値インデックス_温度 | 温度 | floatValue | 部分的なデバイス |
| BeaconValueIndex_Humidity | 湿度 | floatValue |  |
| BeaconValueIndex_Txpower | txパワー | intValue |  |
| BeaconValueIndex_InRange | 範囲内 | ブール値 |  |
| BeaconValueIndex_接続可能 | 接続可能 | ブール値 |  |

上記のインデックスを介して必要なデータを取得するだけです.

今, SDKの基本的な使い方はこれで終わりです, 以下のその他のコード:

デバイスの表示と非表示の変化を聞く.

「」c
// デバイスが消える.
- (空所)mynewBeaconManager:(MinnewBeaconManager *)マネージャーが消えるビーコン:(NSArray<MinewBeacon *> *)ビーコン
{
    NSLog(@"---ビーコンを消す:%@", ビーコン);
}

// デバイスが表示されます.
- (空所)mynewBeaconManager:(MinnewBeaconManager *)マネージャー登場ビーコン:(NSArray<MinewBeacon *> *)ビーコン
{
    NSLog(@"ビーコンが現れる:%@", ビーコン);
}
```

Listen to the Bluetooth state of cellphone.

3 つの Bluetooth 状態:

Bluetooth の状態：BluetoothStatePowerOn（パワーオン），BluetoothStatePowerOff（電源オフ），BluetoothStateUnknown（unknown）

```c
// Bluetooth の状態の変化を聞く
- (空所)mynewBeaconManager:(MinnewBeaconManager *)マネージャーがUpdateStateを実行しました:(Bluetooth の状態)州
{
    NSLog(@"Bluetooth の状態:%LD", (長さ)州);
}
```

you can also check bluetooth state like this:

```c
BluetoothState state = [aマネージャーがBluetoothStateを確認する];

もし(状態 == BluetoothStatePowerOn)
  NSLog(@"Bluetooth は現在電源オンです。");
そうでなければ ...
「」

## クラスリファレンス

### MinewBeacon

Device instance Class,

「」c
// デバイスのデータを取得する
 -(MinnewBeaconValue *)getBeaconValue:(ビーコン値インデックス)索引;

// UUIDの取得など：
  [aBeacon getBeaconValue:BeaconValueIndex_UUID].文字列値;

// からのインデックス "ビーコン値インデックス"；
 // !!!:you should get data by its type
typedef NS_ENUM(NS整数, ビーコン値インデックス) {
     // UUID      
    BeaconValueIndex_UUID = 1,  // 文字列値
    // Major 
    BeaconValueIndex_Major,   // intValue
    // Minor
    BeaconValueIndex_Minor,   // intValue
    // Name
    BeaconValueIndex_Name,   // 文字列値
    // RSSI
    BeaconValueIndex_RSSI,   //  intValue
    // battery
    BeaconValueIndex_BatteryLevel,  // intValue
    // temperature
    BeaconValueIndex_Temperature, 
    // humidity
    BeaconValueIndex_Humidity, 
    // TxPower
    BeaconValueIndex_TxPower,  // intValue
    // in scanning range or not
    BeaconValueIndex_InRage,  // ブール値
    // wechatId，（Partial device）
    BeaconValueIndex_WechatId, // intValue
};
「」

### MinewBeaconValue

Device value instance class

```c
// get int value
@property (非原子的な, 読み取り専用, 割り当てる) NSInteger intValue;

// get float value
@property (非原子的な, 読み取り専用, 割り当てる) float floatValue;

// get string value
@property (非原子的な, 読み取り専用, コピー) NSString *stringValue;

// get data value
@property (非原子的な, 読み取り専用, 強い) NSData *dataValue;

// get bool value
@property (非原子的な, 読み取り専用, 割り当てる) BOOL bool値;
「」

### MinewBeaconManager

Global Manager class.

「」c
// delegate
@protocol MinewBeaconManagerDelegate <NSObject>
@オプション

// 新しいデバイスをスキャンしました, コールバック間隔 3 秒, 
- (空所)mynewBeaconManager:(MinnewBeaconManager * )マネージャー登場ビーコン:(NSArray<MinewBeacon *> *)ビーコン;

// 消えるデバイスを聞いてください (のデータは更新されません 10 2番。)
- (空所)mynewBeaconManager:(MinnewBeaconManager * )マネージャーが消えるビーコン:(NSArray<MinewBeacon *> *)ビーコン;

// 表示されるデバイスを聞く (初めてスキャンされました。)
- (空所)mynewBeaconManager:(MinnewBeaconManager * )マネージャーがやったレンジビーコン:(NSArray<MinewBeacon *> * )ビーコン;

@終わり

// 
@interfaceMinewBeaconManager : NSオブジェクト

// 共有インスタンス
- (MinnewBeaconManager  *)共有インスタンス;

// デバイスのスキャンを開始する, "uuid" uuid 文字列配列です, "有効にする" バックグラウンド スキャン サポートのスイッチです 
- (空所)スキャン開始:(NSArray<NSString *> *)uuids 背景サポート :(ブール)有効にする;

// デバイスのスキャンを停止する.
- (空所)ストップスキャン;

// delegate
@property (非原子的な, 強い) ID <MinewBeaconManagerDelegate> 代表者;

@財産 (非原子的な, 読み取り専用, 割り当てる) Bluetooth の状態

// すべてのデバイスがスキャンされました.
@財産 (非原子的な, 読み取り専用, コピー) NSArray<MinewBeacon *> *スキャンされたビーコン;

// 範囲内のすべてのデバイス.
@財産 (非原子的な, 読み取り専用, コピー) NSArray<MinewBeacon *> *inRangeビーコン;

@end

```

## 変更ログ

-   2017.10.16 英語版
-   2016.12.22 iOSのアップデート 10
-   2016.11.29 新しいファームウェアのアップデート.
-   2016.9.18 Appleのレビューの更新
-   2020.09.18 スキャン v3 デバイスのアップデート。

最終更新:: 12/22/2020, 9:49:53 午前