GizWifiSDK 类

机智云 Wifi SDK 的基础类，为APP开发者提供设备配置和发现、用户登录和注册等功能。

目录

• 属性访问
  • [setListener]
  • [getDeviceList]
• API 定义
  • [sharedInstance]
  • [setListener]
  • [startWithAppInfo]
  • [getVersion]
  • [getPhoneID]
  • [disableLAN]
  • [setDeviceOnboardingDeploy]
  • [setDeviceOnboarding]
  • [stopDeviceOnboarding]
  • [getSSIDList]
  • [getBoundDevices]
  • [bindDevice]
  • [bindDeviceByQRCode]
  • [unbindDevices]
  • [deviceSafetyRegister]
  • [deviceSafetyUnbind]
  • [setUid]
  • [registerUser]
  • [userLogin]
  • [dynamicLogin]
  • [userLoginAnonymous]
  • [userLoginWithThirdAccount]
  • [transAnonymousUser]
  • [userLogout]
  • [changeUserPassword]
  • [changePhoneOrEmail]
  • [resetPassword]
  • [getUserInfo]
  • [changeUserInfo]
  • [requestSendPhoneSMSCode]
  • [setLogLevel]
  • [encryptLog]
  • [channelIDBind]
  • [channelIDUnBind]
  • [userFeedback]
  • [getCurrentCloudService]
  • [getUserTerm]
  • [checkUserTerm]
  • [confirmUserTerm]

属性访问

[setListener]

设置SDK通用监听器

定义

public void setListener(GizWifiSDKListener listener)

[getDeviceList]

GizWifiDevice 对象数组。设备列表缓存，APP 访问该变量即可得到当前 GizWifiSDK 发现的设备列表。

定义

public List<GizWifiDevice> getDeviceList()

API 定义

[sharedInstance]

获取GizWifiSDK单例的实例 返回值返回初始化后 SDK 唯一的实例。SDK 未初始化，或者初始化失败，返回 nil。

定义

public static synchronized GizWifiSDK sharedInstance()

代码示例

GizWifiSDK mSDKInstance = GizWifiSDK.sharedInstance();

[setListener]

设置SDK通用监听器

定义

public void setListener(GizWifiSDKListener listener)

参数

代码示例

GizWifiSDK.sharedInstance().setListener(new GizWifiSDKListener() {
// app根据自己的需要实现回调函数
});

[startWithAppInfo]

启动 SDK。该接口执行成功后，其他接口功能才能正常执行。该接口执行结果由回调didNotifyEvent通知App，回调参数eventID为8316表示SDK启动成功。 如果App要做域名切换和设备类型过滤，则要在此时就指定好域名cloudSeviceInfo和产品信息productInfo。 SDK启动成功后，如果App已经设置了delegate，SDK会立即通过didDiscovered上报发现的设备。

定义

public void startWithAppInfo(Context context, ConcurrentHashMap<String, String> appInfo,
                                 List<ConcurrentHashMap<String, String>> productInfo, ConcurrentHashMap<String, String> cloudServiceInfo)

参数

回调

当发生GizEventType中列举的事件类型时，SDK会主动触发该回调，该回调通知的主要是发生的异常事件

public void didNotifyEvent(GizEventType eventType, Object eventSource, GizWifiErrorCode eventID, String eventMessage)

回调参数

代码示例

// 设置SDK监听
GizWifiSDK.sharedInstance().setListener(mListener);

// 设置AppInfo
ConcurrentHashMap<String, Object> appInfo = new ConcurrentHashMap<String, String>();
appInfo.put("appId", "your_app_id");
appInfo.put("appSecret", "your_app_secret");

// 设置要过滤的设备productKey列表。不过滤则直接传null
List<String> productInfo = new ArrayList<String> ();
ConcurrentHashMap<String, Object> product = new ConcurrentHashMap<String, Object>();
product.put("productKey", "your_product_secret");
product.put("productSecret", "your_product_secret");
productInfo.add(product);

// 指定要切换的域名信息。使用机智云生产环境则传null
// ConcurrentHashMap<String, Object> cloudServiceInfo = new ConcurrentHashMap<String, Object>();
// cloudServiceInfo.put("openAPIInfo", "your_api_domain");

// 调用SDK的启动接口
GizWifiSDK.sharedInstance().startWithAppInfo(context, appInfo, productInfo, null); 

// 实现系统事件通知回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
    @Override
    public void didNotifyEvent(GizEventType eventType, Object eventSource, GizWifiErrorCode eventID, String eventMessage) {
    if (eventType == GizEventType.GizEventSDK) {

    // SDK发生异常的通知
              Log.i("GizWifiSDK", "SDK event happened: " + eventID + ", " + eventMessage);
    } else if (eventType == GizEventType.GizEventDevice) {
              // 设备连接断开时可能产生的通知
              GizWifiDevice mDevice = (GizWifiDevice)eventSource;
              Log.i("GizWifiSDK", "device mac: " + mDevice.getMacAddress() + " disconnect caused by eventID: " + eventID + ", eventMessage: " + eventMessage);
    } else if (eventType == GizEventType.GizEventM2MService) {
              // M2M服务返回的异常通知
              Log.i("GizWifiSDK", "M2M domain " + (String)eventSource + " exception happened, eventID: " + eventID + ", eventMessage: " + eventMessage);
    } else if (eventType == GizEventType.GizEventToken) {
              // token失效通知
              Log.i("GizWifiSDK", "token " + (String)eventSource + " expired: " + eventMessage);
    }
  }
};

[getVersion]

获取 SDK 版本号。 返回值返回当前 SDK 的版本号码

定义

public String getVersion()

代码示例

String sdkVersion = GizWifiSDK.sharedInstance().getVersion();

[getPhoneID]

获取 手机的唯一标志码

定义

public String getPhoneID();

代码示例

String phoneID = GizWifiSDK.sharedInstance().getPhoneID();

[disableLAN]

设置是否禁用小循环功能

定义

public void disableLAN(boolean disabled)

参数

回调

public void didDisableLAN(GizWifiErrorCode result)

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().disableLAN(true);

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public void didDisableLAN(GizWifiErrorCode result) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
                // 设置成功
    } else {
                // 设置失败
    }
  }
};

[setDeviceOnboardingDeploy]

设备配网接口。配网时可自动完成设备域名部署，此接口对模组固件版本向前兼容。 设备处于 softap 模式时，会产生一个热点名称，手机 wifi 连接此热点后就可以配置了。如果是机智云提供的设备wifi固件，热点名称前缀为"XPG-GAgent-"，密码为"123456789"或无密码。设备处于 airlink 模式时，手机随时都可以开始配置 配网时，若检测到手机的配网wifi为5G路由，会通过didNotifyEvent回调通知App，回调中的eventID为8319

参数

回调

如果调用startWithAppInfo接口时指定了待筛选的 productInfo 集合，如果设备被成功配置到路由上并绑定成功，但此设备的productKey不在productInfo指定的productKey中, 会返回配置成功，但不会出现在设备列表中。

public  void didSetDeviceOnboarding(GizWifiErrorCode result, GizWifiDevice device);

回调参数

代码示例

// airlink配置
GizWifiSDK.sharedInstance().setListener(mListener);
List<GizWifiGAgentType> types = new ArrayList();
types.add(GizWifiGAgentType.GizGAgentESP); GizWifiSDK.sharedInstance().setDeviceOnboardingDeploy("your_ssid", "your_key", GizWifiConfigureMode.GizWifiAirLink, null, 60, types);

// softap配置
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().setDeviceOnboardingDeploy("your_ssid", "your_key", GizWifiConfigureMode.GizWifiSoftAP, "XPG-GAgent-DF4A", 60, null);

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public  void didSetDeviceOnboarding(GizWifiErrorCode result, GizWifiDevice device) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
                // 配置成功
    } else {
                // 配置失败
    }
  }
};

[setDeviceOnboarding]

持续获取局域网内未绑定的设备， 直到timeout结束

定义

public void setDeviceOnboarding(int timeout);

参数

回调

public void didSetDeviceOnboarding(GizWifiErrorCode result, List<GizWifiDevice> devices);

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
List<GizWifiGAgentType> types = new ArrayList();
GizWifiSDK.sharedInstance().setDeviceOnboarding(10);

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public void didSetDeviceOnboarding(GizWifiErrorCode result, List<GizWifiDevice> devices) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
                // 配置成功
    } else {
                // 配置失败
    }
  }
};

[stopDeviceOnboarding]

停止设备配网，停止后didSetDeviceOnboarding回调中返回的错误码为GIZ_SDK_ONBOARDING_STOPPED

定义

public void stopDeviceOnboarding();

回调

//停止配置设备回调
public void didSetDeviceOnboarding(GizWifiErrorCode result, GizWifiDevice device);
//停止持续获取局域网未绑定设备回调
public void didSetDeviceOnboarding(GizWifiErrorCode result, List<GizWifiDevice> devices);

回调参数

见【setDeviceOnboardingDeploy】, 【setDeviceOnboarding】

代码示例

// airlink配置
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().stopDeviceOnboarding();

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public void didSetDeviceOnboarding(GizWifiErrorCode result, GizWifiDevice device) {
    if (result == GizWifiErrorCode.GIZ_SDK_ONBOARDING_STOPPED) {
                // 配置终止
    }
  }

  public void didSetDeviceOnboarding(GizWifiErrorCode result, List<GizWifiDevice> devices) {
    if (result == GizWifiErrorCode.GIZ_SDK_ONBOARDING_STOPPED) {
                // 配置终止
    }
  }
};

[getSSIDList]

在 Soft-AP 模式时，获得设备的 SSID 列表。SSID列表通过异步回调方式返回

定义

public void getSSIDList()

回调

public void didGetSSIDList(GizWifiErrorCode result, List<GizWifiSSID> ssidInfoList)

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().getSSIDList();

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public void didGetSSIDList(GizWifiErrorCode result, List<GizWifiSSID> ssidInfoList) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
                // 获取成功
    } else {
                // 获取失败
    }
  }
};

[getBoundDevices]

获取绑定设备列表。在不同的网络环境下，有不同的处理： 当手机能访问外网时，该接口会向云端发起获取绑定设备列表请求； 当手机不能访问外网时，局域网设备是实时发现的，但会保留之前已经获取过的绑定设备； 手机处于无网模式时，局域网未绑定设备会消失，但会保留之前已经获取过的绑定设备； 用户未登录时，无法获取到绑定设备列表。

定义

public void getBoundDevices(List<String> specialProductKey);

参数

回调

以下触发场景触发回调： getBoundDevices接口调用时触发该回调，错误码代表云端请求状态，设备列表是绑定设备与局域网设备合并之后的集合； 设备列表发生变化时会主动上报时触发该回调，此时错误码GIZ_SDK_SUCCESS，设备列表仍然是合并过的集合。

public  void didDiscovered(GizWifiErrorCode result, List<GizWifiDevice> deviceList)

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().getBoundDevices(null); 

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public  void didDiscovered(GizWifiErrorCode result, List<GizWifiDevice> deviceList) {
    // 提示错误原因
    if(result != GizWifiErrorCode.GIZ_SDK_SUCCESS) {
        Log.d("", "result: " + result.name());
    }
    // 显示设备列表
    Log.d("", "discovered deviceList: " + deviceList);
  }
};

[bindDevice]

绑定远端设备到服务器

定义

public void bindDevice(String mac, String productKey, String alias, RequestListener<OpenApiResult<String>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[bindDeviceByQRCode]

根据二维码绑定设备到服务器

定义

public void bindDeviceByQRCode(String QRContent, RequestListener<OpenApiResult<String>> requestListener);

参数

回调参数

代码示例

 Log.d("Hello world!");

[unbindDevices]

从服务器解绑设备

定义

public void unbindDevices(List<GizWifiDevice> devices, RequestListener<OpenApiResult<List<BindDeviceResult>>> requestListener);

参数

回调参数

代码示例

 Log.d("Hello world!");

[deviceSafetyRegister]

设备安全注册接口。向云端加密注册设备，注册成功时返回设备did，同时如果用户已登录则会自动绑定已注册成功的设备，绑定成功的设备会主动触发设备列表更新。需注意，安全注册需要productKey和productSecret，这两个信息应在startWithAppInfo接口参数productInfo的指定范围内

定义

public void deviceSafetyRegister(GizWifiDevice gateway, String productKey, List<ConcurrentHashMap<String, String>> devicesInfo);

参数

回调

public void didDeviceSafetyRegister(List<ConcurrentHashMap<String, String>> successDevices, List<ConcurrentHashMap<String, Object>> failedDevices)

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);

List<ConcurrentHashMap<String, String>> deviceInfos = new ArrayList
<ConcurrentHashMap<String, String>> ();  
ConcurrentHashMap<String, String> deviceInfo = new ConcurrentHashMap
<String, String> ();
deviceInfo.put("mac", "device_mac");
deviceInfo.put("meshID", "your_meshID");
deviceInfo.put("alias", "your_alias");
deviceInfo.put("authCode", "your_authCode");
deviceInfos.add(deviceInfo);

//设备安全注册接口。mDevice 是设备的代理网关
GizWifiSDK.sharedInstance().deviceSafetyRegister(mDevice, "device_productKey", deviceInfos);

// 实现回调
GizWifiSDKListener mListener=new GizWifiSDKListener() {
    @Override
    public void didDeviceSafetyRegister(List<ConcurrentHashMap<String, String>> successDevices, List<ConcurrentHashMap<String,Object>> failedDevices) {
        //接收注册成功和注册失败的设备
    }
};

[deviceSafetyUnbind]

设备安全解绑接口。此接口会在云端把设备的所有关联用户都解绑，可同时解绑多个相同产品类型的设备。但如果设备的产品类型（productKey）不一致将不会解绑任何设备

定义

public void deviceSafetyUnbind(List<ConcurrentHashMap<String, Object>> devicesInfo)

参数

回调

public void didDeviceSafetyUnbind(List<ConcurrentHashMap<String, Object>> failedDevices)

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);

List<ConcurrentHashMap<String, Object>> deviceInfos = new ArrayList
<ConcurrentHashMap<String, Object>> ();  
ConcurrentHashMap<String, Object> deviceInfo = new ConcurrentHashMap<String, Object> ();
deviceInfo.put("device", device);
deviceInfo.put("authCode", "your_authCode");
deviceInfos.add(deviceInfo);

// 设备安全解绑接口
GizWifiSDK.sharedInstance().deviceSafetyUnbind(deviceInfos);

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
    public void didDeviceSafetyUnbind(List<ConcurrentHashMap<String, Object>> failedDevices) {
        //接收解绑失败的设备
    }
};

[setUid]

设置用户uid和token

定义

public void setUid(String uid, String token);

参数

回调

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().setUid("your_uid", "your_token");
// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
};

[registerUser]

用户注册。 需指定用户类型注册。手机用户的用户名是手机号，邮箱用户的用户名是邮箱、普通用户的用户名可以是普通用户名； 注意：如果邮箱注册启用了邮箱激活，会返回注册成功，但不会返回uid、token

定义

public void registerUser(String username, String password, String verifyCode, GizUserAccountType accountType, RequestListener<OpenApiResult<OpenApiLoginResult>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[userLogin]

用户登录。需使用注册成功的用户名、密码进行登录，可以是手机用户名、邮箱用户名或普通用户名

定义

public void userLogin(String username, String password, RequestListener<OpenApiResult<OpenApiLoginResult>> requestListener);

参数

回调参数

代码示例

 Log.d("Hello world!");

[dynamicLogin]

动态验证码登录。登录用户名为手机号，以手机收到的登录验证码登录

定义

public void dynamicLogin(String phone, String code, RequestListener<OpenApiResult<OpenApiLoginResult>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[userLoginAnonymous]

匿名登录。匿名方式登录，不需要注册用户账号。

定义

public void userLoginAnonymous(RequestListener<OpenApiResult<OpenApiLoginResult>> requestListener);

回调参数

代码示例

Log.d("Hello world!");

[userLoginWithThirdAccount]

第三方账号登录（第三方接口登录方式）

定义

public void userLoginWithThirdAccount(GizThirdAccountType thirdAccountType, String uid, String token, String tokenSecret, RequestListener<OpenApiResult<OpenApiLoginResult>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[transAnonymousUser]

匿名用户转换，可转换为手机用户或者普通用户。注意，待转换的帐号必须是还未注册过的

定义

public void transAnonymousUser(String username, String password, String code, GizUserAccountType accountType, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

// 匿名转手机用户
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().transAnonymousUser("your_token", "your_phone_number", "your_password", "your_verify_code", GizUserAccountType. GizUserPhone);

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public  void didTransAnonymousUser(GizWifiErrorCode result) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
    // 转换成功
    } else {
    // 转换失败
    }
  }
};

[userLogout]

注销用户，会将用户已经订阅的设备取消订阅，并删除远程设备列表

定义

public void userLogout();

回调

public void didUserLogout(GizWifiErrorCode result);

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().setUid("your_uid", "your_token");
// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  public void didUserLogout(GizWifiErrorCode result) {
     if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
    // 修改成功
    } else {
    // 修改失败
    }
  }
};

[changeUserPassword]

修改用户密码

定义

public void changeUserPassword(String oldPassword, String newPassword, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[changePhoneOrEmail]

修改账号，只能支持修改手机号或邮箱

定义

public void changePhoneOrEmail(String username, String code, GizUserAccountType accountType, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

 Log.d("Hello world!");

[resetPassword]

重置密码。手机号重置密码时通过手机短信验证码重置，邮箱重置密码时需通过邮箱密码重置链接重置

定义

public void resetPassword(String username, String code, String newPassword, GizUserAccountType accountType, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[getUserInfo]

获取用户信息

定义

public void getUserInfo(RequestListener<OpenApiResult<GizOpenApiUser>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[changeUserInfo]

修改用户个人信息。

定义

public void changeUserInfo(GizOpenApiUser additionalInfo, RequestListener<OpenApiResult<GizOpenApiUser>> requestListener);

参数

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().changeUserInfo("your_token", "your_phone_number", "your_verify_code", GizUserAccountType.GizUserPhone, null);

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public  void didChangeUserInfo(GizWifiErrorCode result) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
    // 修改成功
    } else {
    // 修改失败
    }
  }
};

[requestSendPhoneSMSCode]

通过手机号请求短信验证码

定义

public void requestSendPhoneSMSCode(String phone, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().requestSendPhoneSMSCode ("your_app_secret", "your_phone_number");

// 实现回调
GizWifiSDKListener mListener = new GizWifiSDKListener() {
  @Override
  public void didRequestSendPhoneSMSCode(GizWifiErrorCode result, String token) {
    if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
    // 请求成功
    } else {
    // 请求失败
    }
  }
};

[setLogLevel]

设置日志输出级别。该级别指日志在调试终端和log文件的输出级别，默认是全部输出的。 日志文件存放在SD卡目录下：GizWifiSDK/包名/GizSDKLog/

定义

public void setLogLevel(GizLogPrintLevel logLevel)

参数

代码示例

GizWifiSDK.sharedInstance().setLogLevel(GizLogPrintLevel.GizLogPrintAll);

[encryptLog]

设置日志加密。

定义

public void encryptLog();

代码示例

GizWifiSDK.sharedInstance().encryptLog();

[channelIDBind]

绑定推送的ID到当前用户下，以接收设备的通知事件

定义

public void channelIDBind(String channelID, String alias, GizPushType pushType, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[channelIDUnBind]

解绑推送ID与当前用户的绑定关系，以解除接收设备的通知事件

定义

public void channelIDUnBind(String channelID, RequestListener<OpenApiResult<EmptyBean>> requestListener);

参数

回调参数

代码示例

// 解绑推送ID
Log.d("Hello world!");

[userFeedback]

用户信息反馈接口。此接口无回调，调用后就会上传信息。目前信息上传后，需要联系机智云FAE查看

定义

public void userFeedback(String contactInfo, String feedbackInfo, boolean sendLog);

参数

代码示例

GizWifiSDK.sharedInstance().userFeedback("your_phone", "your_message", true);

[getCurrentCloudService]

查询当前使用的云服务域名信息

定义

接口还未完成

[getUserTerm]

获取用户协议内容

定义

public void getUserTerm(GizUserTermType termType, RequestListener<OpenApiResult<String>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[checkUserTerm]

检查用户协议

定义

public void checkUserTerm(RequestListener<OpenApiResult<GizUserTerm>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");

[confirmUserTerm]

确认用户协议

定义

public void confirmUserTerm(List<GizUserTermType> termTypes, RequestListener<OpenApiResult<String>> requestListener);

参数

回调参数

代码示例

Log.d("Hello world!");