API 列表

下表按 HarmonyOS 原生模块列出面向集成方的主要公开 API。点击“查看使用”可跳转到对应功能下的说明、注意事项和 ArkTS 示例。

sdk

API 名称	介绍	使用
`new GizServerInfo()`	创建 OpenAPI 服务区域配置	查看使用
`new GizProductInfo()`	创建 ProductKey 与 ProductSecret 配置	查看使用
`new GizConfiguration()`	创建 SDK 初始化配置	查看使用
`getProductWithProductKey()`	从初始化配置查找产品	查看使用
`GizSDKManager.initialize()`	初始化核心 SDK	查看使用
`GizSDKManager.initSDK()`	`initialize()` 的兼容命名	查看使用
`GizSDKManager.setDebug()` / `isDebug()`	设置或读取 SDK 调试日志状态	查看使用
`GizSDKManager.isInitialized()`	判断核心 SDK 是否完成初始化	查看使用
`GizSDKManager.getConfiguration()`	读取当前初始化配置	查看使用
`GizSDKManager.getUserManager()`	获取共享用户管理器	查看使用
`GizSDKManager.getVersion()`	读取核心 HAR 版本	查看使用
`GizSDKManager.cleanCache()`	清理日志和数据点配置缓存	查看使用
`GizSDKManager.shutdown()` / `deregister()`	释放核心 SDK 资源	查看使用
`subscribeUserState()`	监听登录状态和用户资料	查看使用
`loginByAnonymous()`	匿名用户登录	查看使用
`loginWithAccount()`	用户名密码登录	查看使用
`sendMobileLoginVerifyCode()` / `loginWithMobile()`	手机验证码登录	查看使用
`sendEmailLoginVerifyCode()` / `loginWithEmail()`	邮箱验证码登录	查看使用
`getAuthorizeData()` / `getUserTokenStream()`	读取或监听授权信息	查看使用
`refreshUserInfo()`	从云端刷新用户资料	查看使用
`logout()`	退出登录并清除用户会话	查看使用
`registerWithAccount()`	注册普通账号	查看使用
`registerWithMobile()` / `registerWithPhone()`	使用手机号和验证码注册	查看使用
`registerWithEmail()`	使用邮箱和验证码注册	查看使用
`forgotWithMobile()`	通过手机号重置密码	查看使用
`forgotWithEmail()`	通过邮箱重置密码	查看使用
`subscribeBoundDeviceList()` / `refreshBoundDeviceList()`	监听或刷新云端绑定设备	查看使用
`GizDeviceManager.getRegisteredDevices()`	获取统一设备缓存	查看使用
`GizDeviceManager.getBoundDevices()`	获取云端绑定设备	查看使用
`GizDeviceManager.getBluetoothDevices()`	获取当前 BLE 设备	查看使用
`GizDeviceManager.getLanDevices()`	获取当前 LAN 设备	查看使用
`GizDeviceManager.subscribeDeviceList()`	监听统一设备列表	查看使用
`GizSDKManager.registerDevice()`	按 ProductKey 与 MAC 注册统一设备对象	查看使用
`GizDevice.register()`	向云端注册设备	查看使用
`GizDevice.bind()` / `GizUserManager.bindDevice()`	绑定设备到当前用户	查看使用
`bindDeviceWithPasscode()`	使用 Device ID 与 Passcode 绑定	查看使用
`GizDevice.updateDeviceInfo()`	修改设备别名和备注	查看使用
`GizDevice.unBind()` / `unbindDevice()`	解绑设备	查看使用
`getName()` / `getRemark()` / `toJsonObject()`	读取设备基础信息与快照	查看使用
`GizDevice.sendDataPoints()`	自动选择可控通道写入数据点	查看使用
`capability.sendDataPoints()`	指定通信通道写入数据点	查看使用
`capability.readDataPoints()`	通过指定通道读取数据点	查看使用
`subscribeDataPointEvents()` / `subscribeDataPoints()`	监听设备上报或当前数据点	查看使用
`capability.subscribeStatus()`	监听通信能力状态	查看使用
`GizState.getValue()` / `subscribe()`	读取和订阅 SDK 状态	查看使用
`setLogDirectory()` / `getLogPath()`	设置日志目录或读取日志路径	查看使用
`GizSDKManager.feedback()`	提交用户反馈并选择是否附带日志	查看使用
`GizOpenApiError`	读取 OpenAPI 异常状态	查看使用

sdk_bluetooth

API 名称	介绍	使用
`GizBluetoothManager.initialize()`	初始化蓝牙模块	查看使用
`subscribeBluetoothDeviceList()`	监听 BLE 发现设备列表	查看使用
`startBleScan()`	启动 BLE 扫描	查看使用
`isScanning()`	判断 BLE 是否正在扫描	查看使用
`stopBleScan()`	停止 BLE 扫描	查看使用
`getAdvertisement()`	获取设备解析后的 BLE 广播	查看使用
`getSession()`	获取设备底层 BLE 会话	查看使用
`bleCapability.connect()`	建立 GATT 连接并鉴权	查看使用
`bleCapability.disconnect()`	断开 BLE 设备	查看使用
`bleCapability.sendDataPoints()`	通过 BLE 写入数据点	查看使用
`bleCapability.readDataPoints()`	通过 BLE 读取数据点	查看使用
`bleCapability.getDeviceInfo()`	通过 BLE 读取设备信息	查看使用
`bleCapability.queryResetFlag()`	通过 BLE 查询设备重置标识	查看使用
`bleCapability.provideWiFiCredentials()`	执行完整 BLE Wi-Fi 配网	查看使用
`bleCapability.stopProvideWiFiCredentials()`	取消 BLE 配网	查看使用
`GizBluetoothManager.configureNetwork()`	仅发送 Wi-Fi 信息的低层接口	查看使用
`bleCapability.checkUpdate()`	检查 BLE 固件更新	查看使用
`bleCapability.startUpgrade()`	启动 BLE OTA	查看使用
`bleCapability.cancelUpgrade()`	取消 BLE OTA	查看使用
`getOtaManager()`	获取底层 `GizBleOTAManager`	查看使用
`isReady()` / `getStatus()`	读取蓝牙模块状态	查看使用
`getVersion()`	读取蓝牙 HAR 版本	查看使用
`shutdown()`	释放蓝牙模块资源	查看使用

sdk_lan

API 名称	介绍	使用
`GizLanManager.initialize()`	初始化局域网模块	查看使用
`subscribeLanDeviceList()`	监听局域网设备列表	查看使用
`startDiscovery()`	启动 UDP 局域网发现	查看使用
`refreshDiscovery()`	立即刷新局域网发现	查看使用
`isDiscovering()`	判断是否正在发现	查看使用
`stopDiscovery()`	停止发现并关闭 Socket	查看使用
`getProfile()` / `getSession()`	获取局域网资料或底层会话	查看使用
`lanCapability.connect()`	连接局域网设备	查看使用
`lanCapability.disconnect()`	断开局域网设备	查看使用
`lanCapability.sendDataPoints()`	通过 LAN 写入数据点	查看使用
`lanCapability.readDataPoints()`	通过 LAN 读取数据点	查看使用
`lanCapability.getDeviceInfo()`	通过 LAN 读取设备信息	查看使用
`lanCapability.queryResetFlag()`	通过 LAN 查询设备重置标识	查看使用
`lanCapability.provideWiFiCredentials()`	执行 LAN Wi-Fi 配网	查看使用
`lanCapability.stopProvideWiFiCredentials()`	取消 LAN 配网	查看使用
`isReady()` / `getStatus()`	读取局域网模块状态	查看使用
`getVersion()`	读取 LAN HAR 版本	查看使用
`shutdown()`	释放局域网模块资源	查看使用

sdk_mqtt

API 名称	介绍	使用
`GizMqttManager.initialize()`	初始化 MQTT 模块并监听用户、设备和网络状态	查看使用
`mqttCapability.subscribeStatus()`	等待单台设备云端通道可控	查看使用
`mqttCapability.connect()` / `connectDevice()`	主动启用单台设备的 MQTT 订阅	查看使用
`mqttCapability.disconnect()` / `disconnectDevice()`	主动停用单台设备的 MQTT 订阅	查看使用
`mqttCapability.sendDataPoints()` / `sendDeviceDataPoints()`	通过 MQTT 写入数据点	查看使用
`mqttCapability.readDataPoints()` / `readDeviceDataPoints()`	通过 MQTT 读取数据点	查看使用
`subscribeDataPointEvents()`	监听并识别 MQTT 数据点上报	查看使用
`mqttCapability.getDeviceInfo()` / `GizMqttManager.getDeviceInfo()`	从云端资料读取设备版本信息	查看使用
`mqttCapability.queryResetFlag()`	通过 MQTT 查询设备重置标识	查看使用
`subscribeBindingEvents()` / `subscribeBindEvent()`	监听 MQTT 设备绑定变化	查看使用
`refreshBoundDeviceList()`	刷新 MQTT 所依赖的绑定设备资料	查看使用
`isReady()` / `getStatus()`	读取 MQTT 模块状态和诊断信息	查看使用
`getVersion()`	读取 MQTT HAR 版本	查看使用
`shutdown()`	关闭服务并释放 MQTT 模块资源	查看使用

生命周期与资源释放