Android接口说明
本文档描述飞天智能音箱配网功能手机客户端接口。
注:
1.本SDK支持的最低版本为4.4。
2.在Android 9中,应用程序执行Wi-Fi扫描的权限要求比之前的版本更加严格,WifiInfo.getSSID()可能返回<unknown ssid>。解决此问题,调用者需要动态申请“ACCESS_FINE_LOCATION”或“ACCESS_COARSE_LOCATION”权限。
接口回调说明:
说明:调用者需要实现LinkCallback,进行调用时需要传递此接口对象,SDK处理请求完成后,通过回调的方式返回执行结果。LinkCallback定义如下:
public interface LinkCallback {
void onLinkResult(int result);
}
onLinkResult方法:SDK调用一键配网接口后回调,result代表错误码。
一键配网
请求接口:public void startLink(Context context, String ssid, String password, LinkCallback callback);
接口功能:给设备配网。
参数名 | 参数说明 |
---|---|
context | 上下文 |
ssid | WiFi名称 |
password | WiFi 密码 |
callback | 回调接口对象 |
返回说明 |
---|
请参考说明中的接口回调说明 |
注:
1.“ssid”需传入当前设备连接的WiFi名称。
2.当前设备连接的WiFi为开放网络时,“password”可为空。
配网类型
请求接口:public CustomerApi setConnectType(NetworkingType type);
接口功能:设置配网类型。
参数名 | 参数说明 |
---|---|
type | 配网类型,枚举值;详见代码中的NetworkingType |
返回说明 |
---|
返回SDK实例 |
热点前缀
请求接口:public CustomerApi setWiFiPrefix(String prefix);
接口功能:设置热点前缀。
参数名 | 参数说明 |
---|---|
prefix | 音箱AP模式产生的热点名称前缀 |
返回说明 |
---|
返回SDK实例 |
注:
1.AirKiss模式下,不需要设置该属性。
2.AP模式下,此属性为可选项,默认热点前缀:“FEITIAN”。
取消配网
请求接口:public void release();
接口功能:释放资源。
参数名 | 参数说明 |
---|---|
无 | 无 |
注:
1.特别的,当配网类型为AirKiss时,建议在离开配网界面时或其他需要终止配网操作的地方调用此接口。
状态码说明
错误码 | 说明 |
---|---|
0 | 成功 |
1 | 超时 |
2 | 当前设备未连接WiFi |
3 | 参数错误 |
4 | 设备连接的WiFi非音箱热点(AP模式下) |
SDK集成
1.导入jar包,将FTNetworkingSDK-v2.0.jar复制到libs目录下,并加入到build path。
2.将armeabi文件夹复制到libs目录下,并在build.gradle中添加:
3.修改AndroidManifest.xml,加入以下权限:
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
4.示例代码: