没有合适的资源?快使用搜索试试~ 我知道了~
Android_SDK2.0_API参考手册1
需积分: 0 0 下载量 50 浏览量
2022-08-03
23:51:24
上传
评论
收藏 4.28MB PDF 举报
温馨提示
试读
144页
1.1. 简介 1.2. 属性方法 1.3. 回调接口
资源详情
资源评论
资源推荐
Gizwits 文档 SDK 2.0 参考手册
-
1
-
GizWifiSDK API Android 参考手册
修订记录
修改时间
修改内容
版本
修改人
备注
2016.5.10
更新目录
0.9.0
Pomia
2016.6.14
校对
1.0.0
Pomia
2016.9.7
增加定时任务接口
1.0.1
Pomia
2016.9.27
增加新接口说明
1.0.2
Pomia
2016.10.19
启动接口中增加域名、pk 过滤参数
设备配置时的模组类型增加一个自定义枚举值
旧的启动接口仍然兼容,但不推荐使用
旧的切换域名接口仍然兼容,但不推荐使用
定时任务接口已废弃,不推荐使用
1.0.3
Pomia
2016.11.7
启动接口参数使用变更
增加设备全球域名部署接口
1.0.4
Pomia
2016.11.30
startWithAppID 接口增加开启设备域名自动设
置参数
setDeviceServerInfo 接口 mac 参数使用变
更
1.0.5
Pomia
2017.1.25
增加新的设备定时任务接口
增加设备分享接口
增加一些枚举定义
1.0.6
Pomia
2017.4.13
增加新的添加子设备接口
1.0.7
Pomia
2017.8.14
增加用户反馈接口
1.0.8
Pomia
2017.8.15
修改启动接口功能描述
1.0.9
Pomia
2017.9.30
增加新的启动接口
新增设备 OTA 接口、中控分组、场景接口 补充
错误码、枚举定义
1.1.0
Pomia
2017.10.13
补充定时任务 attrs 说明
1.1.1
Pomia
2017.12.22
修改启动接口说明
新增配网接口
新增停止配网接口
设备类增加 rootDevice 变量
修改错误码说明
1.1.2
Pomia
2018.4.16
修改启动接口说明
修改配网接口说明
远端设备绑定接口增加参数
新增设备 QRCode 绑定接口
新增分享权限转移接口
设备类增加 attrStatus 状态缓存变量
错误码增加 8319
1.1.3
Pomia
Gizwits 文档 SDK 2.0 参考手册
-
2
-
模组类型增加芯海模组
2018.7.2
设备类增加数据点内容变量
设备类增加固件版本号变量
增加设备网络类型枚举
邮箱注册增加邮箱激活支持
1.1.4
Pomia
2018.8.21
新增中控联动接口
新增设备的安全注册解绑接口
新增轻网关子设备接口
新增相关错误码和枚举定义
1.1.5
Pomia
2019.4.19
新增推送绑定解绑接口
模组类型增加汉枫 V8
模组模式增加多设备 AirLink 配置模式
更新定时任务 attrs 说明
新增相关错误码
1.1.6
翁丹丽
林英琪
2019.6.21
新增两个订阅接口
1.1.7
翁丹丽
林英琪
2019.9.3
新增 mesh 组网相关接口
1.1.8
翁丹丽
林英琪
2019.11.1
新增蓝牙配网枚举
新增注销账户接口
1.1.9
翁丹丽
2021.1.18
新增双通道设备对象
新增蓝牙设备安全注册接口
新增双通道设备发现回调
1.2.0
翁丹丽
2022.2.10
增加蓝牙配网示例
增加加密注册相关接口
1.2.1
翁丹丽
2022.2.25
增加 OTA、蓝牙本地控制文档
1.2.2
翁丹丽
2022.5.5
增加蓝牙设备配网状态字段,配网前缀允许传数
组,用来定向配网蓝牙设备
1.2.3
翁丹丽
Gizwits 文档 SDK 2.0 参考手册
-
3
-
1. GizWifiSDK 类
1.1.
简介
机智云 Wifi SDK 的基础类,
为 APP 开发者提供设备配置和发现、设备分组、用户登录和注册等
功能
。
1.2. 属性方法
属性方法名
定义
setListener
public void setListener(GizWifiSDKListener listener)
getDeviceList
public List<GizWifiDevice> getDeviceList()
1.3. 回调接
口
以下是 GizWifiSDK 提供的所有回调接口,将在在后续 API 定义中详细介绍:
• didNotifyEvent:SDK 系统事件通知
• didGetCurrentCloudService:服务域名独立部署的回调接口
• didSetDeviceOnboarding:设备配置结果的回调接口
• didDiscovered:设备列表上报的回调接口
• didBindDevice:设备绑定结果的回调接口
• didUnbindDevice:设备解除绑定结果的回调接口
• didRegisterUser:用户注册结果的回调接口
• didUserLogin:用户登录结果的回调接口
• didTransAnonymousUser:匿名用户转换的回调接口
• didChangeUserPassword:更换用户密码结果的回调接口
• didGetUserInfo:获取用户信息的回调接口
• didChangeUserInfo:修改用户信息结果的回调接口
• didGetCaptchaCode:获取图片验证码的回调接口
• didRequestSendPhoneSMSCode:请求手机短信验证码的回调接口
• didVerifyPhoneSMSCode:验证手机短信验证码的回调接口
• didDisableLAN:小循环是否禁用的回调接口
• didGetSSIDList:获取设备周围 Wi-Fi 热点列表的回调接口
• didChannelIDBind:绑定推送 ID 的回调接口
Gizwits 文档 SDK 2.0 参考手册
-
4
-
• didChannelIDUnBind:解绑推送 ID 的回调接口
• didDiscoveredMeshDevices:获取蓝牙 Mesh 设备的回调接口
• didChangeDeviceMesh:切换蓝牙 Mesh 设备组网的回调
• didRestoreDeviceFactorySetting:恢复蓝牙 Mesh 设备出厂设置的回调
• didAddDevicesToGroup:添加蓝牙 Mesh 设备到分组的回调
• didDeleteDevicesToGroup:将蓝牙 mesh 设备从指定分组删除的回调
• didGetDeviceGroups:获取设备所在分组集合的回调
• didRegistBleDevice:注册蓝牙设备回调接口
• didDiscoverBleDevice:本地双通道设备发现回调
1.4. API 定义
【sharedInstance】
定义
public static synchronized GizWifiSDK sharedInstance()
功能描述
获取 GizWifiSDK 单例的实例。
返回值
SDK 唯一的实例。
代码示例
GizWifiSDK mSDKInstance = GizWifiSDK.sharedInstance();
【setListener】
定义
public void setListener(GizWifiSDKListener listener)
功能描述
设置 SDK 通用监听器
参数
listener
GizWifiSDKListener 回调对象
代码示例
GizWifiSDK.sharedInstance().setListener(new GizWifiSDKListener() {
// app 根据自己的需要实现回调函数
});
【startWithAppInfo】
定义
public void startWithAppInfo(Context context, <ConcurrentHashMap<String,
String> appInfo, List<ConcurrentHashMap<String, String>> productInfo,
ConcurrentHashMap<String, String> cloudServiceInfo, boolean
autoSetDeviceDomain)
功能描述
启 动 SDK 。 该 接 口 执 行 成 功 后 , 其 他 接 口 功 能 才 能 正 常 执 行 。 该 接 口 执 行 结 果 由 回 调
didNotifyEvent 通知 App,回调参数 eventID 为 8316 表示 SDK 启动成功。
如果 App 要做域名切换和设备类型过滤,则要在此时就指定好域名 cloudSeviceInfo 和产品
信息 productInfo。
SDK 启动成功后,如果 App 已经设置了 listener,SDK 会立即通过 didDiscovered 上报发
Gizwits 文档 SDK 2.0 参考手册
-
5
-
现的设备。
参数
context
上下文对象
appInfo
应用信息,格式:{"appId": "xxx", "appSecret": "xxx"}。
此参数不能填 nil,appId 和 appSecret 必须为有效值。
在机智云开发者中心 dev.gizwits.com 中,每个注册的设备在
对应的“应用配置”中,都能够查到对应的 appId 和 appSecret
productInfo
此参数为选填。
产 品 信 息 数 组 , 格 式 : [{"productKey": "xxx",
"productSecret": "xxx", "usingAdapter": "xxx"}],
其中 usingAdapter 选填,可选项见 GizAdapterType。
当 usingAdapter 为 GizAdapterWifiBle 时,用来标识模组支
持蓝牙近场控制,SDK 会自动发现这个产品。
如果填写了此参数,需保证 productKey 和 productSecret 都
为有效值,否则会被忽略。SDK 会根据此参数过滤设备列表
cloudServiceInfo
服务器域名信息。
如果使用机智云全球部署域名,此参数填 null,此时 SDK 将自动
匹配对应的域名服务。
独立部署时此参数必须指定域名信息,形如:xxx.gizwits.com
如 果 要 使 用 特 殊 端 口 号 , 可 指 定 Http 端 口 :
xxx.gizwits.com:81 , 或 同 时 指 定 Http 和 Https 端 口 :
xxx.gizwits.com:81&8443。
参数为字典格式:
{
"openAPIInfo": "xxx", // String类型,api服务域名,
必填
"siteInfo": "xxx" // String类型,site服务域名,
可不填
"pushInfo": "xxx" // String类型,推送服务域名,
可不填
}
autoSetDeviceDomain
此参数仅用于全球部署,而设备全球部署已由 SDK 在设备配网时自
动完成,因此该参数不再生效。
回调
public void didNotifyEvent(GizEventType eventType, Object eventSource,
GizWifiErrorCode eventID, String eventMessage)
回调说明
当发生 GizEventType 中列举的事件类型时,SDK 会主动触发该回调,该回调通知的主要是发
生的异常事件
回调参数
eventType
事件类型。指明发生了哪一类的事件,详细见 GizEventType 枚
举定义
eventSource
事件源,指是谁触发的事件。如果 eventType 是 GizEventSDK,
剩余143页未读,继续阅读
蓝洱
- 粉丝: 22
- 资源: 316
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 基于FPGA控制28BYJ48型四相八拍电机步进电机实验Verilog逻辑源码Quartus工程文件+文档说明资料.zip
- 机智云-植物宝制作stm32单片机程序源码+ android app源码+文档说明资料.zip
- php-leetcode题解之整数反转.zip
- php-leetcode题解之只出现一次的数字.zip
- php-leetcode题解之重复N次的元素.zip
- php-leetcode题解之找出第K大的异或坐标值.zip
- php-leetcode题解之移动零.zip
- php-leetcode题解之有效的数独.zip
- php-leetcode题解之寻找旋转排序数组中的最小值.zip
- php-leetcode题解之验证二叉搜索树.zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0