信标扫描SDK - 迷你信标扫描

信标扫描SDK

# MinewBeacon 扫描软件开发套件指南

## 安装

### CocoaPods

MinewBeaconScan is available through [可可豆荚](http://cocoapods.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开始扫描:uuid背景支持: 不];

// 2. 禁用位置更新并在项目中使用蓝牙 LE 配件.

//  聚苯乙烯: 由于iOS的限制, 如果某些设备不支持后台扫描, 当应用程序进入后台时，您将无法获取设备的这些数据, 尽管申请进程并未处于暂停状态.
```

for the developer require background task：

````c
  // 1. 将背景支持设置为 YES
  [aManager开始扫描:uuid背景支持 :是的];
   
  // 2、启用位置更新并使用蓝牙 LE 配件。同时, 你需要添加 "NSLocationAlwaysUsageDescription" 项目的 info.plist 文件.

// 聚苯乙烯：SDK将切换到后台模式并继续扫描,是否有设备支持后台模式, 所有委托方法都会正常执行.
```

Configs for "信息列表"

````c
   
<key>NS蓝牙外设使用说明</key> 
<string>应用程序将使用蓝牙与设备通信.</string> 
   
<key>NSLocationUsageDescription</key> 
<string>应用程序将记录您的位置</string> 
 
<key>NSLocationWhenInUseUsageDescription</key> 
<string>应用程序将记录您的位置</string> 
  

 
<key>NSLocationAlwaysUsageDescription</key> 
<string>应用程序将记录您的位置</string> 
````

## Get Started

MinewBeaconManager (作为下面的经理) 可以扫描或停止扫描周围的设备, 它将创建 **Minewbeacon**(正如下面的信标) 每个设备的实例. 它会监听数据更新并出现(如果设备没有在几秒钟内更新数据，我们认为它就消失了, 我们认为如果第一次扫描或从以下位置扫描设备就会出现 "消失" ) 设备状态, 同时, 管理器会监听手机蓝牙状态的变化. 这是下面的代码:

1.  获取管理器共享实例, 设置委托:

```c
MinewBeaconManager *manager = [MinewBeaconManager 共享实例];
经理.委托=自我;
````

2.  开始扫描设备.

````c
[管理员开始扫描:@[@"uuid1", @"uuid2",...] 背景支持:不];
````

3.  从委托方法获取设备数据.

````c
// 如果管理员找到设备, 该方法每秒执行一次, 
- (空白)我的BeaconManager:(MinnewBeaconManager *)经理 didRangeBeacons:(NSArray<MinewBeacon *> *)信标
{
    NS日志(@"当前信标:%@", 信标);
}
````

4.  获取beacon实例的数据.
    
    通过方法 "-(MinnewBeaconValue \*)获取Beacon值:(信标价值指数)指数". 数据多功能性, 我们使用 **MinewBeaconValue** 来处理所有类型的数据, BeaconValue 实例可以是字符串, 整数, 浮点数或布尔值, 每一个 "指数" 对应一个值, 如下面的代码:

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

// uuid
NSString *uuid = [信标获取BeaconValue:BeaconValueIndex_UUID].字符串值; 
// major
NSInteger major = (长的)[信标获取BeaconValue:BeaconValueIndex_Major].整数值;
// minor
NSInteger minor = (长的)[信标获取BeaconValue:BeaconValueIndex_Minor].整数值;
```

Table for ValueIndex and data types

| 指数 | 数据名称 | 类型 | 细节 |
| --- | --- | --- | --- |
| BeaconValueIndex_UUID | uuid | 字符串值 |  |
| BeaconValueIndex_Name | 姓名 | 字符串值 |  |
| BeaconValueIndex_Major | 主要的 | 整数值 |  |
| BeaconValueIndex_Minor | 次要的 | 整数值 |  |
| BeaconValueIndex_WechatId | 微信ID | 整数值 | 部分装置 |
| BeaconValueIndex_Mac | MAC地址 | 字符串值 | 部分装置 |
| BeaconValueIndex_RSSI | 接收信号强度 | 整数值 |  |
| BeaconValueIndex_BatteryLevel | 电池 | 整数值 |  |
| BeaconValueIndex_温度 | 温度 | 浮点值 | 部分装置 |
| BeaconValueIndex_湿度 | 湿度 | 浮点值 |  |
| BeaconValueIndex_Txpower | 发射功率 | 整数值 |  |
| BeaconValueIndex_InRange | 在范围内 | 布尔值 |  |
| BeaconValueIndex_Connectable | 可连接 | 布尔值 |  |

你只需要通过上面的索引获取你想要的数据.

现在, 我们就完成了SDK的基本使用, 下面有更多代码:

聆听设备出现和消失的变化.

````c
// 消失设备.
- (空白)我的BeaconManager:(MinnewBeaconManager *)经理消失信标:(NSArray<MinewBeacon *> *)信标
{
    NS日志(@"---消失信标:%@", 信标);
}

// 出现设备.
- (空白)我的BeaconManager:(MinnewBeaconManager *)经理出现信标:(NSArray<MinewBeacon *> *)信标
{
    NS日志(@"出现信标:%@", 信标);
}
```

Listen to the Bluetooth state of cellphone.

三种蓝牙状态:

蓝牙状态：蓝牙状态PowerOn（开机），BluetoothStatePowerOff（关闭电源），BluetoothStateUnknown（unknown）

```c
// 监听蓝牙状态的变化
- (空白)我的BeaconManager:(MinnewBeaconManager *)经理 didUpdateState:(蓝牙状态)状态
{
    NS日志(@"蓝牙状态:%LD", (长的)状态);
}
```

you can also check bluetooth state like this:

```c
BluetoothState state = [aManager 检查蓝牙状态];

如果(状态 == 蓝牙状态PowerOn)
  NS日志(@"蓝牙现已开机。");
否则如果 ...
````

## 类参考

### MinewBeacon

Device instance Class,

````c
// 获取设备数据
 -(MinnewBeaconValue *)获取Beacon值:(信标价值指数)指数;

// 比如获取UUID：
  [aBeacon getBeaconValue:BeaconValueIndex_UUID].字符串值;

// 索引来自 "信标价值指数"；
 // !!!:you should get data by its type
typedef NS_ENUM(NS整数, 信标价值指数) {
     // UUID      
    BeaconValueIndex_UUID = 1,  // 字符串值
    // Major 
    BeaconValueIndex_Major,   // 整数值
    // Minor
    BeaconValueIndex_Minor,   // 整数值
    // Name
    BeaconValueIndex_Name,   // 字符串值
    // RSSI
    BeaconValueIndex_RSSI,   //  整数值
    // battery
    BeaconValueIndex_BatteryLevel,  // 整数值
    // temperature
    BeaconValueIndex_Temperature, 
    // humidity
    BeaconValueIndex_Humidity, 
    // TxPower
    BeaconValueIndex_TxPower,  // 整数值
    // in scanning range or not
    BeaconValueIndex_InRage,  // 布尔值
    // 微信ID，（Partial device）
    BeaconValueIndex_WechatId, // 整数值
};
````

### MinewBeaconValue

Device value instance class

```c
// get int value
@property (非原子的, 只读, 分配) NSInteger intValue;

// get float value
@property (非原子的, 只读, 分配) 浮动浮动值;

// get string value
@property (非原子的, 只读, 复制) NSString *字符串值;

// get data value
@property (非原子的, 只读, 强的) NSData *数据值;

// get bool value
@property (非原子的, 只读, 分配) BOOL 布尔值;
````

### MinewBeaconManager

Global Manager class.

````c
// delegate
@protocol MinewBeaconManagerDelegate <NSObject>
@选修的

// 扫描新设备, 回调每个 3 秒, 
- (空白)我的BeaconManager:(MinnewBeaconManager * )经理出现信标:(NSArray<MinewBeacon *> *)信标;

// 监听消失的设备 (不更新数据 10 第二。)
- (空白)我的BeaconManager:(MinnewBeaconManager * )经理消失信标:(NSArray<MinewBeacon *> *)信标;

// 监听出现的设备 (第一次扫描。)
- (空白)我的BeaconManager:(MinnewBeaconManager * )经理 didRangeBeacons:(NSArray<MinewBeacon *> * )信标;

@结尾

// 
@接口MinewBeaconManager : NS对象

// 共享实例
- (MinnewBeaconManager  *)共享实例;

// 开始扫描设备, "uuid" 是一个uuid字符串数组, "使能够" 是后台扫描支持的开关 
- (空白)开始扫描:(NSArray<NSString *> *)uuid背景支持 :(布尔值)使能够;

// 停止扫描设备.
- (空白)停止扫描;

// delegate
@property (非原子的, 强的) ID <MinewBeaconManagerDelegate> 代表;

@财产 (非原子的, 只读, 分配) 蓝牙状态

// 扫描的所有设备.
@财产 (非原子的, 只读, 复制) NSArray<MinewBeacon *> *扫描信标;

// 范围内的所有设备.
@财产 (非原子的, 只读, 复制) NSArray<MinewBeacon *> *范围内信标;

@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 是