DOCUMENT.md · 流绪微梦/FDSMeshLibDemo

# iOS Mesh SDK说明文档

## 一.SDK说明
+ iOS库：FDSMeshLib.framework
+ 支持的iOS版本：iOS9-最新
+ 开发语言：Objective-C
+ 编译环境：Xcode13及以上

## 二.工程介绍
### 1.下载和集成
+ 代码仓库：https://gitee.com/liuxuweimeng/fdsmesh-lib-demo.git
+ SDK路径：FDSMeshLibDemo -> ThirdPart -> FDSMeshLib -> FDSMeshLib.framework

### 2.权限配置
+ UIFileSharingEnabled  文件共享权限
+ NSBluetoothPeripheralUsageDescription  蓝牙权限
+ NSBluetoothAlwaysUsageDescription 蓝牙权限
+ NSAppTransportSecurity 网络权限
+ UIBackgroundModes 蓝牙后台权限

### 3.SDK集成配置
+ targets -> search paths -> framework search paths -> sdk相对路径
+ targets -> build phases -> link binary with libraries 需要添加sdk
+ targets -> build phases -> 新增new copy files phase -> destination 选择frameworks -> 添加sdk

## 三.FDSMeshApi接口
+ 接口类：FDSMeshApi
+ 调用方式：类方法调用

### 1.获取SDK版本号
```
/**
 获取SDK版本号

@return 版本x.x.x
 */
+ (NSString *)getVersion;
```
### 2.初始化SDK，接入使用需要申请AppId
```
/**
 初始化SDK，接入使用需要申请AppId

@param appId 应用AppId
 */
+ (void)startWithAppId:(NSString *)appId;
```
### 3.启用SDK日志
```
/**
 启用SDK日志

@param isOpen YES表示启用，NO表示关闭
 */
+ (void)openSdkLog:(BOOL)isOpen;
```
### 4.配置是否开启状态查询
```
/**
 配置是否开启状态查询
 
 @param isCheck YES表示开启(默认)，NO表示关闭
 */
+ (void)configWorkCheck:(BOOL)isCheck;
```
### 5.配置服务器Provision地址管理方式
```
/**
 配置服务器Provision地址管理方式
 
 @param isCheck YES-规则分配，防冲突(默认)，NO-规则分配
 */
+ (void)configServerProvisionType:(BOOL)isCheck;
```
### 6.配置连接参数
```
/**
 配置连接参数
 
 @param connectTimeout 蓝牙连接超时，默认70.0s
 @param serviceTimeout 扫描服务超时，默认20.0s,
 @param retryCount 重试次数，默认2次
 */
+ (void)configConnectParams:(NSTimeInterval)connectTimeout serviceTimeout:(NSTimeInterval)serviceTimeout retryCount:(NSInteger)retryCount;
```
### 7.获取节点列表
```
/**
 获取节点列表

@return 节点列表
 */
+ (NSArray<FDSMeshNodeModel*>*)getNodes;
```
### 8.获取组列表
```
/**
 获取组列表

@return 组列表
 */
+ (NSArray<FDSMeshGroupModel*>*)getGroups;
```
### 9.获取未订阅组的节点列表
```
/**
 获取未订阅组的节点列表

@return 节点列表
 */
+ (NSArray<FDSMeshNodeModel*>*)getNodesWhitOutGroup;
```
### 10.刷新节点列表和组
```
/**
 刷新节点列表和组
 */
+ (void)refreshNodesAndGroups;
```
### 11.获取直连节点
```
/**
 获取直连节点

@return 直连节点
 */
+ (FDSMeshNodeModel*)getConnectedNode;
```
### 12.根据MAC地址获取指定节点
```
/**
 根据MAC地址获取指定节点

@param macAddress 节点MAC地址
 @return 节点
 */
+ (FDSMeshNodeModel*)getNodeByMacAddress:(NSString*)macAddress;
```
### 13.根据单播地址获取指定节点
```
/**
 根据单播地址获取指定节点

@param address 单播地址
 @return 节点
 */
+ (FDSMeshNodeModel *)getNodeByAddress:(NSString *)address;
```
### 14.根据组地址获取组
```
/**
 根据组地址获取组
 
 @param address 组地址
 @return 组
 */
+ (FDSMeshGroupModel *)getGroupByAddress:(UInt16)address;
```
### 15.清除脏节点数据
```
/**
 清除脏节点数据

@param macAddress 节点MAC地址
 */
+ (void)clearDirtyNodeByMacAddress:(NSString *)macAddress;
```
### 16.修改直连节点并重启网络
```
/**
 修改直连节点并重启网络
 
 @param fdsNodeModel 节点，如果传nil则自动连接任意一个节点
 */
+ (void)changeConnectedNode:(FDSMeshNodeModel *_Nullable)fdsNodeModel;
```
### 17.过滤组网后自动连接的设备列表
```
/**
 过滤组网后自动连接的设备列表
 
 @param macAddressList MAC地址列表
 */
+ (void)filterAutoConnectedNode:(NSArray<NSString*> *)macAddressList;
```
### 18.扫描设备
```
/**
 扫描设备

@param filterName 基于设备的localname进行过滤，传空默认不过滤
 @param completion 蓝牙外设对象回调
 */
+ (void)startScanDevice:(NSString *)filterName completion:(void (^)(CBPeripheral *peripheral))completion;
```
### 19.停止扫描
```
/**
 停止扫描
 */
+ (void)stopScan;
```
### 20.快速模式组网
```
/**
 快速模式组网
 
 @param peripherals 蓝牙外设对象列表
 @param progressAction 设备组网回调
 @param resultAction 组网完成回调
 */
+ (void)startAddDeviceToNetWork:(NSArray<CBPeripheral*>*)peripherals progressAction:(void (^)(BOOL success, CBPeripheral *peripheral))progressAction resultAction:(void (^)(BOOL finish, NSArray *addrList))resultAction;
```
### 21.通用模式组网
```
/**
 通用模式组网
 
 @param peripherals 蓝牙外设对象列表
 @param progressAction 设备组网回调
 @param resultAction 组网完成回调
 */
+ (void)startAddDeviceToNetWorkNormal:(NSArray<CBPeripheral*>*)peripherals progressAction:(void (^)(BOOL success, CBPeripheral *peripheral))progressAction resultAction:(void (^)(BOOL finish, NSArray *addrList))resultAction;
```
### 22.移除节点
```
/**
 移除节点
 
 @param nodeModel 节点
 @param isSupport 是否支持删除离线节点
 @return YES表示删除成功，NO表示删除失败
 */
+ (BOOL)removeNode:(FDSMeshNodeModel *)nodeModel isSupportOutOfLine:(BOOL)isSupport;
```
### 23.批量移除节点
```
/**
 批量移除节点
 
 @param nodeList 节点列表
 @param progressAction 节点回调
 @param resultAction 接口回调
 @return YES表示删除成功，NO表示删除失败
 */
+ (BOOL)batchRemoveNode:(NSArray<FDSMeshNodeModel *>*)nodeList progressAction:(void (^)(BOOL success, FDSMeshNodeModel *nodeModal))progressAction resultAction:(void (^)(BOOL finish))resultAction;
```
### 24.重命名节点名属性
```
/**
 重命名节点名属性
 
 @param nodeModel 节点
 @param name 节点名称
 @param type 节点类型
 @param firmwareVersion 节点蓝牙固件版本
 @return YES表示成功，NO表示失败
 */
+ (BOOL)renameNode:(FDSMeshNodeModel *)nodeModel name:(NSString *)name type:(NSString *)type firmwareVersion:(NSString *)firmwareVersion;
```
### 25.创建组
```
/**
 创建组
 
 @param name 组名称
 @param address 组地址
 @return YES表示创建成功，NO表示创建失败
 */
+ (BOOL)createGroup:(NSString *)name address:(UInt16*)address;
```
### 26.重命名组
```
/**
 重命名组
 
 @param groupModel 组
 @param name 组名称
 @return YES表示重命名成功，NO表示重命名失败
 */
+ (BOOL)renameGroup:(FDSMeshGroupModel *)groupModel name:(NSString *)name;
```
### 27.移除组
```
/**
 移除组
 
 @param groupModel 组
 @return YES表示删除成功，NO表示删除失败
 */
+ (BOOL)removeGroup:(FDSMeshGroupModel *)groupModel;
```
### 28.配置节点“订阅/取消订阅”组
```
/**
 配置节点“订阅/取消订阅”组
 
 @param nodeModel 节点
 @param groupModel 组
 @param isAdd YES表示订阅到组，NO表示取消订阅
 @return YES表示成功，NO表示失败
 */
+ (BOOL)configSubscribe:(FDSMeshNodeModel *)nodeModel groupModel:(FDSMeshGroupModel *)groupModel isAdd:(BOOL)isAdd;
```
### 29.配置节点批量“订阅/取消订阅”组
```
/**
 配置节点批量“订阅/取消订阅”组
 
 @param nodeList 节点列表
 @param groupModel 组
 @param isAdd YES表示订阅到组，NO表示取消订阅
 @param progressAction 设备订阅回调
 @param resultAction 订阅完成回调
 @return YES表示成功，NO表示失败
 */
+ (BOOL)configSubscribeGroup:(NSArray<FDSMeshNodeModel *>*)nodeList groupModel:(FDSMeshGroupModel *)groupModel isAdd:(BOOL)isAdd progressAction:(void (^)(BOOL success, FDSMeshNodeModel *nodeModal))progressAction resultAction:(void (^)(BOOL finish))resultAction;
```
### 30.检测和刷新节点在线状态
```
/**
 检测和刷新节点在线状态
 */
+ (void)refreshWorkNormal;
```
### 31.配置节点自动上报在线状态
```
/**
 配置节点自动上报在线状态
 
 @param isOn YES表示开启自动上报，NO表示取消自动上报
 @param nodeList 节点列表
 @param resultAction 配置回调，方便上层保存MESH JSON
 */
+ (void)configNodePuslishState:(BOOL)isOn nodeList:(NSArray<FDSMeshNodeModel *>*)nodeList resultAction:(void (^)(BOOL isSuccess))resultAction;
```
### 32.发送OpINI数据
```
/**
 发送OpINI数据
 
 @param iniData 需要上层组装原始数据 iniData like "a3ff000000000200ffffc21102c4020100".
 @param completion 回响应回调
 */
+ (void)sendOpINIData:(NSData *)iniData completion:(void (^)(NSData *responseData))completion;
```
### 33.发送消息数据
```
/**
 发送消息数据
 
 @param address 发送地址
 @param sendData 消息数据
 @param opcode 操作码 - Godox:0xF0
 @param vendorId 供应商ID - Godox:0x0211
 @param responseMax 回复的节点个数
 @param responseOpcode 回响应操作码 - Godox:0xF0或0xF1
 @param retryCount 重发次数 - Godox:0
 @param completion 回响应回调
 */
+ (void)sendMessageAddress:(UInt16)address sendData:(NSData *)sendData opcode:(UInt8)opcode vendorId:(UInt16)vendorId  responseMax:(UInt8)responseMax responseOpcode:(UInt8)responseOpcode retryCount:(NSInteger)retryCount completion:(void (^)(NSData *responseData))completion;
```
### 34.导入/替换Mesh信息（内部自动云端同步）
```
/**
 导入/替换Mesh信息（内部自动云端同步）
 
 @param meshJson 组网JSON信息
 @param isRequest 是否同步云端：本地操作不需要同步，分享导入等操作需要同步
 @return 最新的provisionAddress, 注意0xFFFF为无效值不能同步到云端
 */
+ (UInt16)importMeshJson:(NSDictionary *)meshJson isRequest:(BOOL)isRequest;
```
### 35.判断能否导入Mesh信息（内部自动云端同步，需要搭配importMeshJson_Ex接口使用）
```
/**
 判断能否导入Mesh信息（内部自动云端同步，需要搭配importMeshJson_Ex接口使用）
 
 @param meshJson 组网JSON信息
 @param server_address 从云端获取最新的provisionAddress
 @param isForce 默认传NO，如果传YES则AppUUID会强制修改，后台会重新分配地址（慎传YES避免地址达到上限）
 @return YES表示能导入，NO表示无法导入
 */
+ (BOOL)canImportMeshJson:(NSDictionary *)meshJson isForce:(BOOL)isForce server_address:(NSInteger *)server_address;
```
### 36.导入/替换Mesh信息
```
/**
 导入/替换Mesh信息
 
 @param meshJson 组网JSON信息
 @param provisionAddress 外部传入的provisionAddress，范围0-0x7FFF
 @return 最新的provisionAddress, 注意0xFFFF为无效值不能同步到云端
 */
+ (UInt16)importMeshJson_Ex:(NSDictionary *)meshJson provisionAddress:(UInt16)provisionAddress;
```
### 37.获取初始Mesh信息（新增场景时需要）
```
/**
 获取初始Mesh信息（新增场景时需要）
 
 @return Mesh Json字符串
 */
+ (NSString *)getInitMeshJson;
```
### 38.获取当前Mesh信息（保存或分享场景时需要）
```
/**
 获取当前Mesh信息（保存或分享场景时需要）
 
 @return Mesh Json字符串
 */
+ (NSString *)getCurrentMeshJson;
```
### 39.开启OTA升级
```
/**
 开启OTA升级
 
 @param otaData 固件数据
 @param nodeModel 节点
 @param progressAction 进度回响应
 @param resultAction 结果回响应
 @return YES表示开启成功，NO表示开启失败
 */
+ (BOOL)startOTAWithOtaData:(NSData *)otaData nodeModel:(FDSMeshNodeModel *)nodeModel progressAction:(void(^)(float progress))progressAction resultAction:(void (^)(BOOL isSuccess))resultAction;
```
### 40.结束OTA升级
```
/**
 结束OTA升级
 */
+ (void)stopOTA;
```
### 41.开启MCU OTA升级
```
/**
 开启MCU OTA升级
 
 @param otaData 固件数据
 @param version 固件版本
 @param nodeModel 节点
 @param progressAction 进度回响应
 @param resultAction 结果回响应
 @return YES表示开启成功，NO表示开启失败
 */
+ (BOOL)startMcuOTAWithOtaData:(NSData *)otaData version:(UInt16)version nodeModel:(FDSMeshNodeModel *)nodeModel progressAction:(void(^)(float progress))progressAction resultAction:(void (^)(BOOL isSuccess))resultAction;
```
### 42.结束MCU OTA升级
```
/**
 结束MCU OTA升级
 */
+ (void)stopMcuOTA;
```

流绪微梦/FDSMeshLibDemo

简介

发行版

贡献者

近期动态

流绪微梦/FDSMeshLibDemo .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

流绪微梦/FDSMeshLibDemo