비콘스캔 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. backgroundSupport를 NO로 설정 
    [aManager startScan:UUID 배경지원: 아니요];

// 2. 위치 업데이트를 비활성화하고 프로젝트에서 Bluetooth LE 액세서리를 사용합니다..

//  추신: iOS 제한으로 인해, 일부 장치가 백그라운드 스캔을 지원하지 않는 경우, 앱이 백그라운드로 들어가면 기기에 대한 이러한 데이터를 얻을 수 없습니다., 신청 절차가 일시 중지된 상태는 아니지만.
```

for the developer require background task：

``c
  // 1. backgroundSupport를 YES로 설정
  [aManager startScan:UUID 배경지원 :예];
   
  // 2、위치 업데이트를 활성화하고 동시에 Bluetooth LE 액세서리를 사용합니다., 추가해야 해 "NSLocationAlwaysUsageDescription" 프로젝트의 info.plist 파일에 항목을 추가하세요..

// 추신：SDK가 백그라운드 모드로 변경되고 계속해서 스캔됩니다.,백그라운드 모드를 지원하는 장치가 있는 경우, 모든 대리자 메서드는 정상적으로 실행됩니다..
```

Configs for "info.plist"

``c
   
<key>NS블루투스주변기기사용설명</key> 
<string>앱은 블루투스를 사용하여 기기와 통신합니다..</string> 
   
<key>NSLocationUsage설명</key> 
<string>앱이 귀하의 위치를 기록합니다</string> 
 
<key>NSLocationWhenInUseUsage설명</key> 
<string>앱이 귀하의 위치를 기록합니다</string> 
  

 
<key>NSLocationAlwaysUsageDescription</key> 
<string>앱이 귀하의 위치를 기록합니다</string> 
````

## Get Started

MinewBeaconManager (아래 관리자로) 주변의 스캔 장치를 스캔하거나 중지할 수 있습니다., **Minewbeacon**이 생성됩니다.(아래 비콘으로) 모든 장치에 대한 인스턴스. 데이터 업데이트를 듣고 나타납니다.(몇 초 내에 데이터를 업데이트하지 않으면 기기가 사라진 것 같습니다., 처음으로 스캔했거나 다음에서 스캔한 경우 장치가 나타난 것으로 생각합니다. "사라지다" ) 장치 상태, 동시에, 관리자는 휴대폰의 블루투스 상태 변화를 듣습니다.. 아래 코드는 다음과 같습니다.:

1.  Manager 공유 인스턴스 가져오기, 대리인 설정:

```c
MinewBeaconManager *manager = [MinewBeaconManager sharedInstance];
Manager.delegate = 본인;
````

2.  장치 검색 시작.

``c
[관리자 startScan:@[@"uuid1", @"uuid2",...] 배경지원:아니요];
````

3.  대리자 메서드에서 장치 데이터 가져오기.

``c
// 관리자가 기기를 발견한 경우, 이 메소드는 매초마다 실행됩니다, 
- (무효의)minewBeaconManager:(MinewBeaconManager *)관리자 didRangeBeacons:(NSArray<MinewBeacon *> *)비콘
{
    NSLog(@"현재 비콘:%@", 비콘);
}
````

4.  비콘 인스턴스의 데이터를 가져옵니다.
    
    방법을 통해 "-(MinewBeacon값 \*)getBeacon값:(비콘가치지수)색인". 데이터 다양성을 위해, 모든 유형의 데이터를 처리하기 위해 **MinewBeaconValue**를 사용합니다., BeaconValue 인스턴스는 문자열일 수 있습니다., 정수, 부동 소수점 또는 부울, 모든 "색인" 값에 해당, 아래 코드와 같이:

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

// uuid
NSString *uuid = [비콘 getBeaconValue:BeaconValueIndex_UUID].문자열값; 
// major
NSInteger major = (긴)[비콘 getBeaconValue:BeaconValueIndex_Major].정수값;
// minor
NSInteger minor = (긴)[비콘 getBeaconValue: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 | RSSI | 정수값 |  |
| BeaconValueIndex_BatteryLevel | 배터리 | 정수값 |  |
| BeaconValueIndex_Temperature | 온도 | float값 | 부분 장치 |
| BeaconValueIndex_습도 | 습기 | float값 |  |
| BeaconValueIndex_Txpower | txPower | 정수값 |  |
| BeaconValueIndex_InRange | 범위 내 | 부울값 |  |
| BeaconValueIndex_Connectable | 연결 가능 | 부울값 |  |

위의 인덱스를 통해 원하는 데이터를 얻으면 됩니다..

지금, SDK의 기본적인 사용을 마치겠습니다, 아래에 더 많은 코드가 있습니다:

장치가 나타나고 사라지는 변화를 들어보세요.

``c
// 사라지는 장치.
- (무효의)minewBeaconManager:(MinewBeaconManager *)관리자가 사라지다비콘:(NSArray<MinewBeacon *> *)비콘
{
    NSLog(@"---비콘이 사라지다:%@", 비콘);
}

// 장치가 나타나다.
- (무효의)minewBeaconManager:(MinewBeaconManager *)관리자 표시비콘:(NSArray<MinewBeacon *> *)비콘
{
    NSLog(@"비컨이 나타나다:%@", 비콘);
}
```

Listen to the Bluetooth state of cellphone.

세 가지 블루투스 상태:

블루투스상태：BluetoothStatePowerOn(파워온)，BluetoothStatePowerOff(전원 끄기)，BluetoothStateUnknown（unknown）

```c
// 블루투스 상태 변화를 들어보세요
- (무효의)minewBeaconManager:(MinewBeaconManager *)관리자가 UpdateState를 수행했습니다.:(블루투스상태)상태
{
    NSLog(@"블루투스 상태:%ld", (긴)상태);
}
```

you can also check bluetooth state like this:

```c
BluetoothState state = [aManager check블루투스상태];

만약에(상태 == BluetoothStatePowerOn)
  NSLog(@"이제 Bluetooth가 PowerOn 상태입니다.");
그렇지 않으면 ...
````

## 수업 참고자료

### MinewBeacon

Device instance Class,

``c
// 장치의 데이터를 가져옵니다
 -(MinewBeacon값 *)getBeacon값:(비콘가치지수)색인;

// 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 초, 
- (무효의)minewBeaconManager:(MinewBeaconManager * )관리자 표시비콘:(NSArray<MinewBeacon *> *)비콘;

// 사라지는 장치를 들어보세요 (데이터를 업데이트하지 않습니다 10 두번째.)
- (무효의)minewBeaconManager:(MinewBeaconManager * )관리자가 사라지다비콘:(NSArray<MinewBeacon *> *)비콘;

// 나타나는 장치를 들어 (처음으로 스캔했습니다.)
- (무효의)minewBeaconManager:(MinewBeaconManager * )관리자 didRangeBeacons:(NSArray<MinewBeacon *> * )비콘;

@끝

// 
@interface MinewBeaconManager : NSObject

// 공유 인스턴스
- (MinewBeaconManager  *)공유인스턴스;

// 스캔 장치 시작, "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 오전