美文网首页
6-机智云iOS SDK文档介绍

6-机智云iOS SDK文档介绍

作者: 野比大雄001 | 来源:发表于2018-09-06 19:26 被阅读25次

一、GizWifiSDk使用:

1、功能:初始化、基本设置、用户管理、设备管理

2、属性:delegte、deviceList

3、主要回调接口:服务域名独立部署,设备列表,设备周围wifi,设备配置结果,绑定设备,解除绑定设备,获取图片验证码,请求验证码,确定验证码,注册,登录,忘记密码,修改密码,获取用户信息,修改用户信息

4、单例对象 【sharedInstance】 

5、开始APP信息 【startWithAppInfo】 

6、查询云服务域名信息 【getCurrentCloudService】 

7、获取SDK版本 【getVersion】 

8、设置日志调试输出级别 【setLogLevel】 

9、是否禁用循环 【disableLAN】 

10、获取设备的SSID列表【getSSIDList】 

11、停止设备配网(广播) 【stopDeviceOnboarding】 

12、Wi-Fi固件必须是04020027及以上版【setDeviceOnboardingDeploy】 

13、获取设置域名的设备列表 【getDevicesToSetServerInfo】 

14、设置设备的云服务域名接口 【setDeviceServerInfo】 

15、获取绑定设备列表 【getBoundDevices】 

16、绑定远程设备 【bindRemoteDevice】 

17、解除绑定设备 【unbindDevice】

18、获取图片验证码 【getCaptchaCode】 

19、请求短信验证码 【requestSendPhoneSMSCode】 2个参数

20、通过图形获取短信验证码 【requestSendPhoneSMSCode】 3个参数

21、验证短信验证码 【verifyPhoneSMSCode】 

22、注册用户注册 【registerUser】 

23、匿名用户登录 【userLoginAnonymous】 

24、用户登录 【userLogin】 

25、第三方账号登录 【userLoginWithThirdAccount】 

26、修改用户密码 【changeUserPassword】 

27、忘记密码(重置)【resetPassword】 

28、修改用户信息 【changeUserInfo】 

29、获取用户信息 【getUserInfo】 

30、匿名用户转换为手机用户 【transAnonymousUser】 

31、用户反馈信息 【userFeedback】 

二、GizWifiDevice使用:

1、功能:设备订阅、设备数据通知,设备实时状态通知(热水器水温)

2、属性:delegte、macAddress、did(设备云端标识)、ipAddress、productKe(产品识别码)、productName、productType、remark(设备备注信息)、alias(设备别名)、netStatus、isLAN 、isBind 、isDisabled(是否注销) 、isSubscribed (是否订阅)、isProductDefined(是否定义产品数据点) 、

sharingRole(设置用户权限) 、rootDevice(子设备的根设备分为:网关,单品和中控)

3、主要回调接口:设备硬件信息、设备绑定信息、设备退出产品测试、设备订阅和解除订阅、设备网络状态变化、设备数据上报

4、更新设备网络状态 【didUpdateNetStatus】 

5、设备订阅和解除订阅 【setSubscribe】 

6、获取设备状态 【getDeviceStatus】 

7、向设备发送控制指令【write】 

8、修改设备的备注和别名(绑定设备后才可以修改)【setCustomInfo】 

9、获取硬件信息 【getHardwareInfo】 

10、退出产品测试模式 【exitProductionTesting】 

三、GizWifiCentralControllerDevice使用:

1、功能:获取中控子设备列表、添加中控子设备、删除中控子设备

2、属性:setDeviceList(中控子设备列表)

3、主要回调接口:中控子设备列表

4、子设备列表回调【didUpdateSubDevices】 

5、添加子设备 【addSubDevice】 

6、删除子设备 【deleteSubDevice】 

7、同步更新子设备 【updateSubDevices】 

四、GizWifUserInfo使用:

1、功能:用户信息存储

2、属性:uid、username、email、phone、isAnonymous(是否匿名用户)、lang、name、userGender、birthday、address、remark、deiceBindTime

五、GizWifSSID使用:

1、功能:路由的SSID信息,包括SSID名和信号强度

2、属性:ssid、rssi

六、GizDeviceSharing使用:

1、功能:提供设备分享功能,用户绑定设备后,其他人可以通过设备分享的方式使用设备。 

2、4类用户的权限:

normal:设备没有被分享过时,任何已绑定的用户都是 normal 用户,设备仍然可以 被其他用户绑定; 

special:只有第一个绑定设备的用户才可以分享设备,并成为 owner 

owner:用户有 owner 后,其他用户不可以再绑定设备,只能通过分享的方式使用 设备。owner 用户可以解绑所有其他已绑定用户 

guest:接受分享邀请的用户是 guest 用户 

3、主要回调接口:获取设备已绑定用户,解绑设备已绑用户,获取分享邀请列表,创建分享邀请,撤回分享邀请,接受分享邀请,查看二维码邀请信息,扫码接受分享邀请,修改分享别名,查询消息列表,标记或删除消息

4、设备分享的委托 【setDelegate】

5、查询设备的已绑定用户列表  【getBindingUsers】 

6、解绑设备的已绑定用户 【unbindUser】 

7、查询设备的分享邀请列表 【getDeviceSharingInfos】 

8、创建分享邀请【sharingDevice】 

9、撤回分享邀请 【revokeDeviceSharing】 

10、接受分享邀请 【acceptDeviceSharing】 

11、查看二维码邀请信息【checkDeviceSharingInfoByQRCode】 

12、接受二维码分享邀请 【acceptDeviceSharingByQRCode】 

13、修改分享邀请别名  【modifySharingInfo】 

14、查询消息列表  【queryMessageList】 

15、标记消息已读或删除  【markMessageStatus】

七、GizDeviceSharingInfo使用:

1、功能:分享设备信息

2、属性:id、deviceID、productName、deviceAlias、deviceID、userInfo、alias、way、status、createdAt、updateAt、expiredAt

八、GizMessage使用:

1、功能:发送消息

2、属性:id、type、status、createAt、updateAt、content

九、GizDeviceOTA使用:

1、功能:设备固件升级

2、属性:delegate

3、主要回调接口:检查固件更新的、固件开始升级的、设备固件有更新的主动通知 、固件升级状态的主动通知 

4、检查设备更新的回调 【didCheckDeviceUpdate】 

5、设备开始升级的回调  【didUpgradeDevice】 

6、设备固件有更新的主动通知 【didNotifyDeviceUpdate】 

7、设备升级状态的主动通知 【didNotifyDeviceUpgradeStatus】 

8、检查固件是否有更新 【checkDeviceUpdate】 

9、开始升级 【upgradeDevice】 

十、GizDeviceGroupCenter使用:

1、功能:中控子设备分组操作,包括创建设备分 组、删除、更新设备分组列表等功能 

2、属性:delegate

3、主要回调接口:中控子设备列表 

4、获取指定网关设备上的分组列表  【didCheckDeviceUpdate】 

5、组列表回调接口 【didUpdateGroups】 

6、添加分组 【addGroup】 

7、删除设备分组 【removeGroup】 

8、更新分组列表  【updateGroups】 

十一、GizDeviceGroup使用:

1、功能:设备分组控制、编辑组设备、修改组信息 

2、属性:delegate、groupID、groupOwner、groupType、groupName、groupDeviceList

3、主要回调接口:组信息更新、组设备列表更新 、组操作 

4、分组信息更新回调  【didUpdateGroupInfo】 

5、组设备列表更新回调 【didUpdateGroupDevices】 

6、分组控制的回调接口 【didWrite】 

7、修改设备分组信息  【editGroupInfo】 

8、添加组设备  【addGroupDevice】 

9、删除设备分组   【removeGroupDevice】 

10、更新分组列表  【updateGroupDevices】 

11、执行组操作  【write】 

十二、GizDeviceSceneCenter使用:

1、功能:中控子设备分组操作 

2、属性:delegate

3、主要回调接口:中控场景设备列表回调 

4、获取指定网关设备上的场景列表 【getSceneListGateway】 

5、场景列表回调接口 【didUpdateScenes】 

6、添加场景 【addScene】 

7、删除场景 【removeScene】 

8、更新场景列表 【updateScenes】 

十三、GizDeviceScene使用:

1、功能:场景执行、场景编辑 

2、属性:delegate、sceneID、sceneOwner、sceneName、sceneItemList

3、主要回调接口:场景信息更新、场景项列表更新、场景状态更新 

4、场景信息更新回调  【didUpdateSceneInfo】 

5、场景项列表更新回调  【didUpdateSceneItems】 

6、场景状态更新回调  【didUpdateSceneStatus】 

7、场景执行回调   【didExecuteScene】 

8、编辑场景信息  【editSceneInfo】 

9、编辑场景项列表 【editSceneItems】 

10、启动或取消场景执行  【editSceneItems】 

11、更新场景的执行状态  【updateSceneStatus】 

十四、GizDeviceSceneItem使用:

1、功能:场景项信息(设备场景项、组场景项和延时场景项 ) 

2、属性:device、group、data、delayTime、sceneItemType

3、主要回调接口:场景信息更新、场景项列表更新、场景状态更新 4、创建设备场景项对象  【sceneItemWithDevice】 

5、创建组场景项对象 【sceneItemWithGroup】 

6、创建延时场景项对象  【sceneItemWithDelay】 

十五、GizDeviceSchedulerCenter使用:

1、功能:设备定时任务管理功能,管理用户在设备上设置的定时任务 

2、属性:device

3、主要回调接口:定时任务列表回调

4、获取云端定时任务列表 【getSchedulerListCloud】 

5、定时任务列表回调接口 【didUpdateSchedulers】 

6、创建定时任务  【createScheduler】 

7、删除定时任务  【deleteScheduler】 

8、同步更新设备定时任务列表  【updateSchedulers】 

十六、GizDeviceScheduler使用:

1、功能:云端定时任务类,可设置一次性定时任务、按月重复的定时任务、按周重复的 定时任务。一次性定时任务是指只执行一次定时任务,按月重复定时任务是指在每月特定日期执行定时任务, 按周重复定时任务是指在每周特定时间执行定时任务。 

2、属性:delegate、schedulerID、schedulerOwner、date、time、weekdays、monthDays、enabled、remark、date、attires、schedulerType、startDate、endDate、createDateTime

3、主要回调接口:定时任务列表回调 

4、定时任务信息更新回调 【didUpdateSchedulerInfo】 

5、创建一次性云端定时任务时使用此构造方法 【schedulerOneTime】 

6、创建按周重复的云端定时任务时使用此构造方【schedulerWeekRepeat】 

7、创建按日重复的云端定时任务时使用此构造方法【schedulerDayRepeat】 

8、修改定时任务信息,此接口可用于修改云端或中控的定时任务信息。【editSchedulerInfo】 

十七、枚举的使用:

日志打印级别 【GizLogPrintLevel】 

事件通知类型 【GizEventType】 

设备配置模式  【GizWifiConfigureMode】 

设备类型  【GizWifiDeviceType】 

第三方账号类型  【GizThirdAccountType】 

机智云用户类型  【GizUserAccountType】 

设备网络状态类型  【GizWifiDeviceNetStatus】 

模组类型  【GizWifiGAgentType】 

用户性别  【GizUserGenderType】 

不同的用户角色设备分享时具有不同的设备绑定权限  【GizDeviceSharingUserRole】 

设备分享类型  【GizDeviceSharingType】 

分享方式  【GizDeviceSharingWay】 

设备分享状态  【GizDeviceSharingStatus】 

消息类型  【GizMessageType】 

消息状态 【GizMessageStatus】 

固件升级类型  【GizOTAFirmwareType】 

场景项类型  【GizSceneItemType】 

定时任务类型  【GizSchedulerType】 

定时任务执行状态  【GizScheduleStatus】 

按周重复 【GizScheduleWeekday】 

错误码定义  【GizWifErrorCode】 

相关文章

网友评论

      本文标题:6-机智云iOS SDK文档介绍

      本文链接:https://www.haomeiwen.com/subject/akcfgftx.html