iOS接口说明
本文档描述飞天智能音箱配网功能手机客户端接口。
注：
1.本SDK支持的最低版本为8.0。
2.connectionSuccess与connectionFailure为成功或失败后的回调block,调用接口后需要调用该回调获取结果。
3.集成SDK后需要在App中开启Access WiFi Information.(TARGETS→Capabilities),以获取手机当前连接的WiFi.。
4.AP配网模式下回调结果仅为网络是否畅通,实际结果取决于音箱播报的配网结果.
接口回调说明:
1. 成功回调
请求接口：(^AirKissConnectionSuccess) (void)
示例程序：
connection.connectionSuccess = ^{
//do something
};
2. 失败回调
请求接口：(^AirKissConnectionFailure) (int code)
| 参数名 | 参数说明 |
|---|---|
| code | 错误码 |
示例程序：
connection.connectionFailure = ^(int code) {
//do something
};
初始化对象
请求接口：+ (id)sharedInstance;
接口功能：初始化,获取对象。
| 参数名 | 参数说明 |
|---|---|
| 无 | 无 |
| 参数名 | 参数说明 |
|---|---|
| id | 返回的实例对象 |
示例程序：
//初始化
FTConnection *connection = [FTConnection sharedInstance];
一键配网
请求接口：- (void)connectWithSSID:(NSString *)ssid password:(NSString *)password;
接口功能：给设备配网。
| 参数名 | 参数说明 |
|---|---|
| ssid | WiFi 名称(必填) |
| password | WiFi 密码(无密码时可为空) |
| 返回说明 |
|---|
| 请参考说明中的接口回调说明 |
示例程序：
//初始化
FTConnection *connection = [FTConnection sharedInstance];
//配网
[connection connectWithSSID:self.ssid.text password:self.pwd.text];
配网类型
请求接口：@property (nonatomic,assign) FTNetWorkingType conType;
接口功能：设置配网类型。
| 参数名 | 参数说明 |
|---|---|
| conType | 配网类型，枚举值；详见代码中的FTNetWorkingType |
| 返回说明 |
|---|
| 请参考说明中的接口回调说明 |
示例程序：
//设置配网类型
[connection setConType:FTAirKiss];
热点前缀
请求接口：@property (nonatomic,strong) NSString *connectPrefix;
接口功能：设置热点前缀。
| 参数名 | 参数说明 |
|---|---|
| connectPrefix | 音箱AP模式产生的热点名称前缀(当且仅当airkiss模式下,不需要设置该属性) |
示例程序：
//设置音箱热点前缀
[connection setConnectPrefix:kHostpotPre];
反初始化
请求接口：- (int)unInit;
接口功能: 释放资源。
| 参数名 | 参数说明 |
|---|---|
| 无 | 无 |
示例程序：
//在退出当前页面时使用
[connection unInit];
状态码说明
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 超时 |
| 2 | 当前设备未连接WiFi |
| 3 | 参数错误 |
| 4 | 设备连接的WiFi非音箱热点(AP模式下) |
| 5 | 网络错误 |
SDK集成
1.将SDK拖进工程。
2.导入头文件：
3.示例代码：
3.1 Airkiss模式
3.2 AP模式
