iOS蓝牙SDK集成文档 V1.1
一.简述
锦浪云近端调试SDK是集成锦浪逆变器近端调试功能的开发者工具。SDK不仅提供易用、稳定、统一的接口,而且提供可换肤的UI界面。开发者可根据自己的业务实现蓝牙近端调试相关功能。
二.IOS蓝牙SDK集成
2.1 SDK接入
2.1.1 开发环境
- iOS 12.0或更高
- Xcode 11.0或更高版本(建议使用最新版本)
2.1.2 配置信息
- SDK接入
- 与开发人员取得联系获取最新的Release版本
- 将NearToolSDK.framework 及LocalOperation.bundle添加到你的Xcode工程中
- Link Binary With Libraries的配置
TARGETS->Build Phases-> Link Binary With Libaries
确保NearToolSDK.framework添加至Link Binary With Libraries且选项Status设置为Required
- 资源文件bundle配置
将 LocalOperation.bundle 资源文件集成到项目中,确保与 NearToolSDK 在同一目录下
2.1.3 权限配置
IOS使用蓝牙必须先允许定位,所以需要开启定位。使用蓝牙需要用户同意才可使用。
在工程 info.plist 文件中需要添加 定位请求和蓝牙请求 的权限。
定位权限
Privacy - Location When In Use Usage Description
蓝牙权限
Privacy - Bluetooth Peripheral Usage Description
iOS 使用蓝牙配网时,需要获取 WiFi 信息,需要开发者配置证书时勾选 Access Wi-Fi Information
在 Xcode 项目里面,在 Capacity 添加 Access Wi-Fi Information
2.1.4 初始化&加载视图
步骤1:头文件引入
在需要调用SDK的控制器中引入 #import <NearToolSDK/NearToolSDK.h>
步骤2:加载视图
NearToolHomeViewController *vc = [[NearToolHomeViewController alloc] init];
//push展示
// [self.navigationController pushViewController:vc animated:YES];
//present展示
[self presentViewController:vc animated:YES completion:nil];
步骤3:接入成功截图
2.2 API使用
2.2.1 设置密钥
homeVC.appKey = @"xxxxxx";
2.2.2 设置APIKey/APISecret
homeVC.apiKey = @"xxxxxx";
homeVC.apiSecret = @"xxxxxx";
2.2.3 设置语言
/*
NearToolLanguageTypeCN = 1, ///<中文
NearToolLanguageTypeEN = 2, ///<English
NearToolLanguageTypeES = 3, ///<Español
NearToolLanguageTypePL = 4, ///<Polski
NearToolLanguageTypeDE = 5, ///<Deutsch
NearToolLanguageTypeFR = 6, ///<Français
NearToolLanguageTypeKO = 7, ///<한국어
NearToolLanguageTypeNL = 8, ///<Nederlands
NearToolLanguageTypePT = 9, ///<Português
NearToolLanguageTypeIT = 10, ///<Italiano
NearToolLanguageTypeUK = 11, ///<Українська
NearToolLanguageTypeSV = 12, ///<Svenska
NearToolLanguageTypeVI = 13, ///<Tiếng Việt
NearToolLanguageTypeTH = 14, ///<ภาษาไทย
NearToolLanguageTypeUR = 15, ///<اللغة العربية
NearToolLanguageTypeAR = 16, ///<اردو
NearToolLanguageTypeTR = 17, ///<Türkçe
NearToolLanguageTypeCS = 18, ///<čeština
NearToolLanguageTypeBS = 19, ///<bosanski
*/
homeVC.languageTypeType = NearToolLanguageTypeCN;
2.2.4 设置颜色
//配置主题色
homeVC.mainColor = [UIColor colorWithRed:240/255.0f green:133/255.0f blue:25/255.0f alpha:1.0];
//配置按钮颜色
homeVC.btnColor = [UIColor colorWithRed:240/255.0f green:133/255.0f blue:25/255.0f alpha:1.0];
2.2.5 运行环境(默认国际环境)
//运行环境(默认国际版)
/*
NearToolTargetInternational 国际
NearToolTargetDomestic 国内
*/
homeVC.target = NearToolTargetInternational;
2.2.6 蓝牙配网
连接采集器蓝牙直接进入配网功能
/// adapterType 是否强制开启配网 1开启 0关闭 (默认关闭)
//设置参数
homeVC.adapterType=@"1" //配网必须设置此项,不设置默认进入采集器详情页
配网成功回调(参数:设备 SN)
///配网完成后的返回 附带sn
@property (copy, nonatomic) void(^popSnBlock)(NSString *sn);
///声明成功回调
homeVC.popSnBlock = ^(NSString * _Nonnull sn) {
//配网完成后的返回 参数sn
};
2.3 操作说明
步骤1:打开蓝牙列表
步骤2:进入配网页面
步骤3:点击配置
步骤4:配置完成
2.4 注意事项
需要在真机上运行,使用模拟器编译时会出现报错
需要在APP隐私协议中声明相对应的隐私权限使用说明