API 与版本说明
适用版本:2.1.8。
SDK 管理与返回值
| 接口 | 返回值 / 说明 |
|---|---|
GizSDKManager.sharedInstance.initSDK(config:) | 同步 Void |
GizSDKManager.sharedInstance.getDevices() | async -> [GizDevice],触发云端查询后合并设备列表 |
GizSDKManager.sharedInstance.getProductDataPointConfig(productKey:) | async -> String? |
GizSDKManager.sharedInstance.cleanCache() | 同步 Void,清理缓存 |
GizSDKManager.sharedInstance.feedback(uploadLog:contact:content:) | async -> Void,错误在 SDK 内记录日志 |
GizUserManager.sharedInstance.updateAuthorizeData(token:uid:) | 同步 Void |
GizUserManager.sharedInstance.getAuthorizeData() | GizLoginResultInfo,不是 GizResult |
带 async 的方法放在 Task 或异步函数中调用。其余设备、用户方法若返回 GizResult,检查 success、error 和可空 data。
配网与模组信息
provideWiFiCredentials(ssid:password:timeout:processHandler:bindWithUid:)返回GizResult<GizBaseProfile?, GizActivatorException?>。timeout单位为秒。bindWithUid是Bool?,但没有默认值,调用时必须显式传入。- AI 模组自行与云端建立绑定关系时,必须开启
bindWithUid,并预先完成用户授权。 见 BLE 配网和 AP 配网。 - 模组资料通过
capability.deviceProfile读取,蓝牙资料转为GizBleProfile;其configured是Bool?。netStatus是GizWifiDeviceNetStatus枚举,不能直接与整数比较。 GizProductInfoStruct.cmbDeviceTypeId用于 CMB 模组识别;GizBleProfile.bleModuleVariant与support5GConfig表示模组类型及 5 GHz 配网能力。- AirLink 使用
ESPTouchSmartConfig.sharedInstance.provideWiFiCredentialsWithAirLink(ssid:password:timeout:productKeys:processHandler:),返回GizResult<GizBaseProfile?, GizActivatorException?>。timeout单位为秒,productKeys限定云端确认的产品列表;取消使用stopProvideWiFiCredentialsWithAirLink()。该 API 不接收bindWithUid。
其他公开入口
| 接口 | 说明 |
|---|---|
capability.addDeviceDataListener(closure:) / removeDeviceDataListener(closure:) | 通道级数据监听 |
device.getDataPointConfig() | async -> DataPointConfig?,获取设备对应的数据点配置 |
device.sendDp(json:) | 按已登录通道选择 LAN、BLE、MQTT 下发,返回 GizResult |
device.lanCapability.sendDpToUDP(data:) | LAN UDP 下发 |
device.startMusicalRhythm(sensitivity:mode:callback:) / stopMusicalRhythm() | 音乐律动,同步 Void;需具备录音权限和设备能力 |
userManager.getUserInfo() / changeUserInfo(info:) | 获取、修改用户资料 |
userManager.changeEmail(newEmail:code:) | 更换邮箱入口,服务端行为需结合业务验证 |
userManager.sendEmailChangeEmailVerifyCode(email:lang:) / sendMobileChangeEmailVerifyCode(phoneCode:phone:lang:) | 更换邮箱相关验证码 |
userManager 为 GizUserManager.sharedInstance。transAnonymousUserToEmailUser、transAnonymousUserToPhoneUser、transAnonymousUserToNormalUser 虽为 public,但当前源码只返回空的成功结果,尚未执行实际转换,不能按已实现功能使用。