Android SDK 2.

0 API Reference Manual

Android SDK 2.0 API Reference Manual

1. GizWifiSDK Class
1.1. Introduction
Gizwits Wi-Fii SDK base class, which provides device discovery and configuration,
device control, user login and registration etc.

1.2. Member Functions

Member Functions Definition

setListener public void setListener(GizWifiSDKListener listener)

getDeviceList public List<GizWifiDevice> getDeviceList()

1.3. Callback API

Here are all the callback API of GizWifiSDK, can see details on following API Definition:
• didNotifyEvent： SDK system event notification callback

• didGetCurrentCloudService： stand-alone deployment cloud service domain callback

• didDiscovered： device list change notification callback

• didGetSSIDList： Wi-Fi list of device around callback

• didSetDeviceOnboarding： device Wi-Fi configuration callback

• didBindDevice： device binding callback

• didUnbindDevice： device unbinding callback

• didUpdateProduct： device definition change notification callback

• didGetCaptchaCode： image captcha callback

• didRequestSendPhoneSMSCode： SMS verify-code callback

• didRegisterUser： user registration calback

1
 Android SDK 2.0 API Reference Manual

• didUserLogin： user login calback

• didTransAnonymousUser： anonymous user conversion calback

• didChangeUserPassword： user password change callback

• didChangeUserInfo： user info change callback

• didGetUserInfo： user info callback

1.4. API Definition

【sharedInstance】
Definition public static synchronized GizWifiSDK sharedInstance()
Description get single instance of GizWifiSDK
Returns the single instance of SDK
Sample code GizWifiSDK mSDKInstance = GizWifiSDK.sharedInstance();

【setListener】
Definition public void setListener(GizWifiSDKListener listener)
Description set SDK General Listener
Parameters listener GizWifiSDKListener callback object
GizWifiSDK.sharedInstance().setListener(new GizWifiSDKListener() {
Sample code // app implement the callback function
});

【startWithAppID】
public void startWithAppID(Context context, String appID, String
appSecret, List<String> specialProductKeys,
Definition
ConcurrentHashMap<String, String> cloudServiceInfo, boolean
autoSetDeviceDomain)
This uses to initialize SDK. Only after this API is executed, can other APIs
do. If listener has been set, SDK will report discoverable devices
Description immediately by didDiscovered callback.

If App want to switch cloud service domain and filter devices by

2
 Android SDK 2.0 API Reference Manual

productKey, it should specify domain and productKey while initializing

SDK.

If you want to set domain of device, can enable auto-setting when this
API is called, SDK would let all devices which support setting domain and
App connect to the same cloud service domain, but auto-setting is
disabled by default.

Note: If auto-setting is enable, it will effective and remain in force, you can
call setDeviceServerInfo API to stop auto-setting.
context context object
On Gizwits Developer Zone (dev.gizwits.com),
each registered device can find its appID on its
appid corresponding “application setting”. This
parameter appID doesn’t have default value,
developer must send correct value.
On Gizwits Developer Zone (dev.gizwits.com),
can find appSecret corresponding to appID in
appSecret “application setting”. This parameter
appSecret doesn’t have default value,
developer must pass correct value.
This parameter is device productKeys which
you want to filter, it is String array.
The default value of specialProductKeys is null.
When it is default value, and then SDK would
Parameters specialProductKeys
return all devices. If you want SDK return
devices which have been filtered,
specialProductKeys should be special
productKey.
This parameter is the domain info of service
which you want to connect.
The default value is null. When it is default
value, SDK would base on location of mobile to
set service domain as Gizwits general cloud
service domain.
cloudServiceInfo
If App want to set cloud service domain as
stand-alone deployment, it should pass value
as the following format Dictionary{key: value}
{
"openAPIInfo": "xxx", // String, cloud API
service domain

3
 Android SDK 2.0 API Reference Manual

"siteInfo": "xxx" // String, site service

domain
"pushInfo": "xxx" // String, push service
domain
}
App must pass value of openAPIInfo and
siteInfo, but pushInfo is optional. App can pass
value without specifying port number such as
api.gizwits.com. If App want to specify port
number, it should specify port number of http
and https at the same time, like
xxx.gizwits.com:81&8443.
This parameter is auto-setting of device
domain, the default value is false.
If App pass value is true, it would enable auto-
autoSetDeviceDomain
setting of device domain, device in LAN would
connect to cloud service domain which is using
by App
public void didNotifyEvent(GizEventType eventType, Object
Callback
eventSource, GizWifiErrorCode eventID, String eventMessage)
When the events enumerating in GizEventType happen, SDK would
Callback
trigger this callback, it would notify some exception event, and the event
description
8316 which is SDK start successful.
Event type.It points out which event happens,
eventType can see details on GizEventType enum
definition
event source, it points out who triggers event.
If eventType is GizEventSDK, eventSource is
null. If eventType is GizEventDevice,
Callback eventSource eventSource must be cast to GizWifiDevice. If
parameters eventType is GizEventM2Mservice or
GizEventToken, eventSource must be cast to
String.
Event ID, it points out what happens to
eventID eventSource, can see details on
GizWifiErrorCode enum definition
eventMessage the descriptipn for eventID

// set SDK Listener

Sample code GizWifiSDK.sharedInstance().setListener(mListener);
// Set produceKey list which you want to filter. No need to define this

4
 Android SDK 2.0 API Reference Manual

variable if you don’t want to filter, it would pass null by default

List<String> specialProductKeys = new ArrayList<String> ();

specialProductKeys.add("your_product_key");
// Specify domain info which you want to connect. No need to define this
variable while using Gizwits general cloud service domain, it would pass
null by default

ConcurrentHashMap<String, Object> cloudServiceInfo = new

ConcurrentHashMap<String, Object>();
cloudServiceInfo.put("openAPIInfo", "your_api_domain");
cloudServiceInfo.put("siteInfo", "your_site_domain");
// call SDK start API
GizWifiSDK.sharedInstance().startWithAppID(context, "your_app_id",
"your_app_secret", specialProductKeys, cloudServiceInfo, false);

// implement callback of system event notification

GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didNotifyEvent(GizEventType eventType, Object
eventSource, GizWifiErrorCode eventID, String eventMessage) {
if (eventType == GizEventType.GizEventSDK) {
// notification while SDK gets exception
Log.i("GizWifiSDK", "SDK event happened: " + eventID
+ ", " + eventMessage);
} else if (eventType == GizEventType.GizEventDevice) {
// possible notification when device disconnect
GizWifiDevice mDevice = (GizWifiDevice)eventSource;
Log.i("GizWifiSDK", "device MAC: " +
mDevice.getMacAddress() + " disconnect caused by eventID: " +
eventID + ", eventMessage: " + eventMessage);
} else if (eventType == GizEventType.GizEventM2MService) {
// exception notification returns from M2M service
Log.i("GizWifiSDK", "M2M domain " +
(String)eventSource + " exception happened, eventID: " + eventID + ",
eventMessage: " + eventMessage);
} else if (eventType == GizEventType.GizEventToken) {
// notification when token is invalid
Log.i("GizWifiSDK", "token " + (String)eventSource + "
expired: " + eventMessage);
}
}
};

5
 Android SDK 2.0 API Reference Manual

【getCurrentCloudService】
Definition public void getCurrentCloudService()
Description get current cloud service domain info

public void didGetCurrentCloudService(GizWifiErrorCode result,

Callback
ConcurrentHashMap<String, String> cloudServiceInfo)
Callback description query result
See details on GizWifiErrorCode enum definition,
GIZ_SDK_SUCCESS is success, others are
result
failures. When result is failure, cloudServiceInfo
would be null.
Current cloud service domain info, following is
Callback format for dictionary{key: value}:
parameters
{
cloudServiceInfo "openAPIDomain" : "xxx", // String
"openAPIPort" : "xxx", // String
"siteDomain" : "xxx", // String
"sitePort" : "xxx", // String
}

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

// implement callback
public void didGetCurrentCloudService(GizWifiErrorCode result,
ConcurrentHashMap<String, String> cloudServiceInfo) {
Sample code
if(result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}

【getVersion】
Definition public String getVersion()

Description get SDK version

6
 Android SDK 2.0 API Reference Manual

Returns SDK version

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

【setLogLevel】
Definition public void setLogLevel(GizLogPrintLevel logLevel)
Sets printing log level. This is the printing log level when debug in terminal,
it would print all log by default. Printing log level would not affect log file print,
Description
SDK would write all log into log file no matter what printing log level is. Log
file is stored in directory of SD card: GizWifiSDK/packageName/GizSDKLog/
Parameters logLevel Printing log level, see details on GizLogPrintLevel definition
GizWifiSDK.sharedInstance().setLogLevel(GizLogPrintLevel.
Sample code
GizLogPrintAll);

【getSSIDList】
Definition public void getSSIDList()
Get SSID list of device in Soft-AP mode, SSID list would return from
Description
asynchronous callback.
public void didGetSSIDList(GizWifiErrorCode result, List<GizWifiSSID>
Callback
ssidInfoList)
See details on GizWifiErrorCode enum definition,
Callback result GIZ_SDK_SUCCESS is success, others are failures.
parameters When result is failure, ssidInfoList would be null.
ssidInfoList SSID list consist of GizWifiSSID object
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().getSSIDList();

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didGetSSIDList(GizWifiErrorCode result,
Sample code
List<GizWifiSSID> ssidInfoList) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// get list success
} else {
// get list failure
}
}

7
 Android SDK 2.0 API Reference Manual

};

【setDeviceOnboarding】
public void setDeviceOnboarding(String ssid, String key,
Definition GizWifiConfigureMode mode, String softAPSSIDPrefix, int timeout,
List<GizWifiGAgentType> types)
Configure device to LAN Wi-Fi network. When device in softap mode,
module will create a hotspot, mobile can configure after connecting to
this hotspot. While using firmware of Gizwits, prefix name of module
hotspot should be “XPG-GAgent-” and password should be
“123456789”. When device in airlink mode, mobile can configure at any
time. No matter choosing which configuration mode, when device is
Description
online, only after mobile connects to configuration LAN Wi-Fi, can
confirm that device has configured success.

When device has configured successfully, it would callback MAC

address of device. If device has been reset, maybe you can get DID of
device in callback of device discovering.
SSID SSID SSID of router
key password of router
Configuration mode, see details on
mode
GizWifiConfigureMode enum definition
Prefix name or full name of SoftAP hotspot in
SoftAPMode mode, default prefix should be “XPG-
softAPSSIDPrefi GAgent-”, SDK would base on this parameter to
x judge wether mobile has connected to SoftAP
Parameters hotspot of device or not. In AirLink mode, this
parameter is ignored, just pass null.
timeout Configuration timeout, default is 30s.
Module type waiting for configuration, this is
GizWifiGAgentType enum array, default value is
ESP module. GizWifiGAgentType has defined all
types
types which SDK support, it aslo defines an enum
GizGAgentOther, developers can use any other
configuration library to configure device.
public void didSetDeviceOnboarding(GizWifiErrorCode result, String
Callback
MAC, String DID, String productKey)
Note: If you specify filter productKey while calling getBoundDevices API,
Callback description
when device has been configured to router, it would return configure

8
 Android SDK 2.0 API Reference Manual

success, but it would not be added into device list.

See details on GizWifiErrorCode enum definition,
result GIZ_SDK_SUCCESS is success, others are failures.
When result is failure, other parameters are null.

Callback MAC MAC of device

parameters Did of Device. After configuring successfully, the value of
DID DID may be null, because device will not sure wether it
can get DID from cloud immediately or not.
productKey productKey of device
// airlink configuration
GizWifiSDK.sharedInstance().setListener(mListener);
List<GizWifiGAgentType> types = new ArrayList();
types.add(GizWifiGAgentType.GizGAgentESP);
GizWifiSDK.sharedInstance().setDeviceOnboarding("your_SSID",
"your_key", GizWifiConfigureMode.GizWifiAirLink, null, 60, types);

// softap configuration
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().setDeviceOnboarding("your_SSID",
"your_key", GizWifiConfigureMode.GizWifiSoftAP, "XPG-GAgent-
DF4A", 60, null);
Sample code
// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didSetDeviceOnboarding(GizWifiErrorCode result,
String MAC, String DID, String productKey) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// configure success
} else {
//configure failure
}
}
};

【getBoundDevices】
public void getBoundDevices(String UID, String token, List<String>
Definition
specialProductKey)
Get list of binding devices, in different network, it would have different
Description
operations:

9
 Android SDK 2.0 API Reference Manual

When mobile can access internet, this API would send request to cloud
service to get binding devices. When mobile couldn’t access internet, it
would find devices of LAN in real time, but it would remain devices which
have been bound before. When mobile is out of network, unbinding
devices of LAN would disappear, but it would remain binding devices
which you have got before. Users couldn’t get list of binding devices
without login.

Note: In this API, if the length of UID or token is error, SDK would use
previous UID or token
UID UID get from user login or registration
token token get from user login or registration

Parameters Specify product key of device to search, it is String

specialProductK array, you can specify one or more product key of
eys device, it would return all devices without specifying
any product key.

public void didDiscovered(GizWifiErrorCode result,

Callback
List<GizWifiDevice> deviceList)
Following scene would trigger callback:

Calling getBoundDevices API would trigger this callback, error code

means request status of cloud, list of device means the collection
Callback description merging binding devices and LAN devices.

The changing of device list would trigger this callback, the error code is
GIZ_SDK_SUCCESS, list of device means the collection merging
binding devices and LAN devices.
See details on GizWifiErrorCode enum definition.
result GIZ_SDK_SUCCESS means success, others mean
Callback failures. When result is failure, deviceList is not null.
parameters It is an array consist of GizWifiDevice object. This
deviceLis
parameter would only return devices filter by special
t
productKey.

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().getBoundDevices("your_UID",
"your_token", null);
Sample code
// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override

10
 Android SDK 2.0 API Reference Manual

public void didDiscovered(GizWifiErrorCode result,

List<GizWifiDevice> deviceList) {
// show error reason
if(result != GizWifiErrorCode.GIZ_SDK_SUCCESS) {
Log.d("", "result: " + result.name());
}
// show list of devices
Log.d("", "discovered deviceList: " + deviceList);
}
};

【bindRemoteDevice】
public void bindRemoteDevice(String UID, String token, String MAC,
Definition
String productKey, String productSecret)
Description Bind remote device to server
UID UID get from user login or registration
token token get from user login or registration
MAC MAC of device waiting for binding
Parameters
productKey productKey of device waiting for binding
productSecr
productSecret of device waiting for binding
et

Callback public void didBindDevice(GizWifiErrorCode result, String DID)

See details on GizWifiErrorCode enum definition.
Callback result GIZ_SDK_SUCCESS means success, others mean failures.
parameters When result is failure, DID is null.
DID DID of binding device
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().bindRemoteDevice ("your_UID",
"your_token", "your_device_MAC", "your_device_product_key",
"your_product_secret");

// implement callback
Sample code
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didBindDevice(GizWifiErrorCode result, String DID) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// binding success
} else {

11
 Android SDK 2.0 API Reference Manual

// binding failure
}
}
};

【unbindDevice】
Definition public void unbindDevice(String UID, String token, String DID)
Description unbind device from server
UID UID get from user login or registration
Parameters token token get from user login and registration
DID DID of device waiting for unbinding

Callback public void didUnbindDevice(GizWifiErrorCode result, String DID)

See details on GizWifiErrorCode enum definition.
Callback result GIZ_SDK_SUCCESS means success, others mean failures.
parameters When result is failure, DID is null.
DID DID of unbinded devices
GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().unbindDevice("your_UID", "your_token",
"your_device_ DID ");

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
Sample code public void didUnbindDevice(GizWifiErrorCode result, String DID) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// unbinding success
} else {
// unbinding failure
}
}
};

【getCaptchaCode】
Definition public void getCaptchaCode(String appSecret)
Get image captcha. Developers login on dev.gizwits.com, getting App
Description Secret from user’s application setting, then use App Secret to get image
captcha.

12
 Android SDK 2.0 API Reference Manual

Parameters appSecret secret of app, can see this on dev.gizwits.com

public void didGetCaptchaCode(GizWifiErrorCode result, String token,

Callback
String captchaId, String captchaURL)
See details on GizWifiErrorCode enum definition.
GIZ_SDK_SUCCESS means success, others mean
result
failures. When result is failure, other callback parameters
would be null.
Callback
parameters token token of image captcha, it would be invalid an hour later.
captchaId id of image captcha, it would be invalid 5 minutes later.
URL of image captcha, it would be invalid after captcha
captchaURL
code has been used.

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().getCaptchaCode("your_app_secret");

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didGetCaptchaCode(GizWifiErrorCode result, String
Sample code token, String captchaId, String captchaURL) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}
};

【requestSendPhoneSMSCode】
public void requestSendPhoneSMSCode(String appSecret, String
Definition
phone)
Description Get SMS verify code by phone
appSecret secret of app, can see it on dev.gizwits.com
Parameters
phone phone number

public void didRequestSendPhoneSMSCode(GizWifiErrorCode result,

Callback
String token)
See details on GizWifiErrorCode enum definition.
Callback
result GIZ_SDK_SUCCESS means success, others mean
parameters
failures. When result is failure, token is null.

13
 Android SDK 2.0 API Reference Manual

token get token while request message captcha

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

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didRequestSendPhoneSMSCode(GizWifiErrorCode
Sample code
result, String token) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}
};

【requestSendPhoneSMSCode】
public void requestSendPhoneSMSCode(String token, String captchaId,
Definition
String captchaCode, String phone)
Description Get SMS verify code by image captcha
token get token from getCaptchaCode API
captchaId get captchaId from getCaptchaCode API
Parameters
captchaCode code of image captcha
phone phone number

public void didRequestSendPhoneSMSCode(GizWifiErrorCode result,

Callback
String token)
See details on GizWifiErrorCode enum definition.
Callback result GIZ_SDK_SUCCESS means success, others mean
parameters failures. When result is failure, token is null.
token the token by getCaptchaCode API

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().requestSendPhoneSMSCode
("your_token", "your_captchaId", "your_captchaCode",
Sample code
"your_phone_number");

// implement callback

14
 Android SDK 2.0 API Reference Manual

GizWifiSDKListener mListener = new GizWifiSDKListener() {

@Override
public void didRequestSendPhoneSMSCode(GizWifiErrorCode
result, String token) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}
};

【registerUser】
public void registerUser(String username, String password, String code,
Definition
GizUserAccountType accountType)
Registration should specify account type, username of GizUserPhone is
Description phone number, username of GizUserEmail is email address, username
of GizUserNormal is normal username.
username (phone number, email address or normal
username
username)
password password
SMS verify code, it would be invalid after registration,
code
and it couldn’t be used again.
Parameters
account type, see details on GizUserAccountType enum
definition. If username is phone number, this parameter
should be GizUserPhone. If username is email address,
accountType
this parameter should be GizUserEmail. If username is
normal username, this parameter should be
GizUserNormal.

public void didRegisterUser(GizWifiErrorCode result, String UID, String

Callback
token)
See details on GizWifiErrorCode enum definition.
result GIZ_SDK_SUCCESS means success, others mean
Callback failures. When result is failure, UID and token are null.
parameters
UID get UID afer finishing registration
token get token after finishing registration

GizWifiSDK.sharedInstance().setListener(mListener);
Sample code
GizWifiSDK.sharedInstance().registerUser ("your_phone_number",

15
 Android SDK 2.0 API Reference Manual

"your_password", "your_verify_code",
GizUserAccountType.GizUserPhone);

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didRegisterUser(GizWifiErrorCode result, String UID,
String token) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}
};

【userLoginAnonymous】
Definition public void userLoginAnonymous()
Description Login with anonymous user, no need to register account.

public void didUserLogin(GizWifiErrorCode result, String UID, String

Callback
token)
See details on GizWifiErrorCode enum definition.
result GIZ_SDK_SUCCESS means success, others mean failures.
Callback When result is failure, UID and token are null.
parameters
UID Get UID after finishing registration
token Get token after finishing registration

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

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
Sample code public void didUserLogin(GizWifiErrorCode result, String UID,
String token) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// login success
} else {
// login failure
}

16
 Android SDK 2.0 API Reference Manual

}
};

【userLogin】
Definition public void userLogin(String username, String password)
User login, using username and password which have been registered
Description successfully. username can be phone number, email address and normal
username.
usernam
username
Parameters e
password password

public void didUserLogin(GizWifiErrorCode result, String IOD, String

Callback
token)
See details on GizWifiErrorCode enum definition.
result GIZ_SDK_SUCCESS means success, others mean
Callback failures. When result is failure, UID and token are null.
parameters
UID Get UID after login success
token Get token after login success

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().userLogin("your_user_name",
"your_password");

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didUserLogin(GizWifiErrorCode result, String UID,
Sample code
String token) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// login success
} else {
// login failure
}
}
};

【changeUserPassword】
Definition public void changeUserPassword(String token, String oldPassword,

17
 Android SDK 2.0 API Reference Manual

String newPassword)
Description change user password
token token from user login or registration
oldPassword old password
Parameters
newPasswor
new password
d

Callback public void didChangeUserPassword(GizWifiErrorCode result)

See details on GizWifiErrorCode enum definition.
Callback
result GIZ_SDK_SUCCESS means success, others mean
parameters
failures.

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().changeUserPassword("your_token",
"your_old_password", "your_new_password");

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
Sample code public void didChangeUserPassword(GizWifiErrorCode result) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}
};

【resetPassword】
public void resetPassword(String username, String code, String
Definition
newPassword, GizUserAccountType accountType)
Reset password. GizUserPhone user would reset password by using
Description SMS verify code. GizUserEmail user would reset password by uing
reset-link of email
username It should be phone number or email address.
SMS verify code is required to reset password by phone.
code
Parameters If reset by email, it can be set to null
newPasswor New password. It can be set to null if reset password by
d email.

18
 Android SDK 2.0 API Reference Manual

Account type, see details on GizThirdAccountType

enum definition. If username is phone number, this
accountType
parameter should be GizUserPhone. If username is
email address, this parameter should be GizUserEmail.

Callback public void didChangeUserPassword(GizWifiErrorCode result)

See details on GizWifiErrorCode enum definition.
Callback
result GIZ_SDK_SUCCESS means success, others mean
parameters
failures.

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().resetPassword("your_phone_number",
"your_verify_code", "your_new_password",
GizUserAccountType.GizUserPhone);

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
Sample code
public void didChangeUserPassword(GizWifiErrorCode result) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// success
} else {
// failure
}
}
};

【changeUserInfo】
public void changeUserInfo(String token, String username, String code,
Definition
GizUserAccountType accountType, GizUserInfo additionalInfo)
Change user info, include username and personal additional info.
username can only be changed to phone number or email address which
has been registered before. This API can be used by the following case:
Only change phone number
Only change email address
Only change personal additional info of normal user
Description
Change phone number and additional info
Change email address and additional info
If you only change personal additional info, accountTyoe should be
GizUserNormal. If you change phone number, accountType should be
GizUserPhone. If you change email address, accountType should be
GizUserEmail.

19
 Android SDK 2.0 API Reference Manual

token Token from user login or registration

Username which want to change, it should be phone
username
number or email address.
code SMS verify code which uses to change phone number
account type, see details on GizThirdAccountType enum
definition. If you change phone number, accountType
should be GizUserPhone. If you want to change email
Parameters address, accountType should be GizUserEmail. If you
accountType
only want to change additional info, accountType should
be GizUserNomal. If you want to change username and
additional info, accountType will depend on what
username is.
Additional info wait for changing, see details on
additionalInf GizUserInfo class definition. If you only change
o additional info, need to set value of token, and
username and code as null.

Callback public void didChangeUserInfo(GizWifiErrorCode result)

Callback See details on GizWifiErrorCode enum definition.
result
parameters GIZ_SDK_SUCCESS means success, others mean failures.

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

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
Sample code
public void didChangeUserInfo(GizWifiErrorCode result) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// change info success
} else {
// change info failure
}
}
};

【getUserInfo】
Definition public void getUserInfo(String token)

20
 Android SDK 2.0 API Reference Manual

Description Get user info

Parameters token Token from user login or registration

public void didGetUserInfo(GizWifiErrorCode result, GizUserInfo

Callback
userInfo)
See details on GizWifiErrorCode enum definition.
Callback result
GIZ_SDK_SUCCESS means success, others mean failures.
parameters
userInfo User info, see details of GizUserInfo class

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().getUserInfo ("your_token");

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
@Override
public void didGetUserInfo(GizWifiErrorCode result, GizUserInfo
Sample code userInfo) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// get info success
} else {
// get info failure
}
}
};

【transAnonymousUser】
public void transAnonymousUser(String token, String username, String
Definition
password, String code, GizUserAccountType accountType)
Anonymous user convert to GizUserPhone or GizUserNormal. Note:
Description
username should not be registered before.
token Token fron user login or registration
Username, it should be normal username or phone
username
number
password password
Parameters code SMS verify code
Account type, see details on GizThirdAccountType enum
accountTyp definition. If username is phone number, this parameter
e should be GizUserPhone. If username is normal
username, this parameter should be GizUserNormal.

21
 Android SDK 2.0 API Reference Manual

Callback public void didTransAnonymousUser(GizWifiErrorCode result)

Callback See details on GizWifiErrorCode enum definition.
result
parameters GIZ_SDK_SUCCESS means success, others mean failures.

// transform anonymous user to phone user

GizWifiSDK.sharedInstance().setListener(mListener);
GizWifiSDK.sharedInstance().transAnonymousUser("your_token",
"your_phone_number", "your_password", "your_verify_code",
GizUserAccountType. GizUserPhone);

// implement callback
GizWifiSDKListener mListener = new GizWifiSDKListener() {
Sample code @Override
public void didTransAnonymousUser(GizWifiErrorCode result) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// transform success
} else {
// transform failure
}
}
};

22
 Android SDK 2.0 API Reference Manual

2. GizWifiDevice Class
2.1. Introduction
This is the device class of Gizwits Wi-Fi. GizWifiDevice class provide developers with
device subscriptions, data notices, real-time status updates, device control, with
applications in products such as controlling the water temperature of water heater. The
device object is allocated by GizWifiDevice class, cannot be self-created.

2.2. Member function

【setListener】
Definition public void setListener(GizWifiDeviceListener Listener)
Description Set listener for device
Parameters listener listener of device
// mDevice is the device object obtained from device list
Sample code
mDevice.setListener(new GizWifiDeviceListener() {});

【getMacAddress】
Definition public String getMacAddress()
Gets the MAC address of the device. If it is “Virtual: Site”, then it is a virtual
Description
device.
Returns Returns MAC address of the device.
// mDevice is the device object obtained from list of device
Sample code
String MAC = mDevice.getMacAddress();

【getDid】
Definition public String getDid()
Description Gets DID of the device on cloud
Returns Returns DID of the device
// mDevice is the device object obtained from the device list
Sample code
String DID = mDevice.getDid();

23
 Android SDK 2.0 API Reference Manual

【getIPAddress】
Definition public String getIpAddress()
Gets ip address of device. If device is a WLAN, the ip address is the domain of
Description
cloud server.
Returns Returns the ip address of the device.
// mDevice is the device object obtained from device list
Sample code
String ip = mDevice.getIPAddress();

【getProductKey】
Definition public String getProductKey()
Description Gets the product type identifier of the device
Returns Returns the product type identifier of the device
// mDevice is the device object obtained from list of device
Sample code
String productKey = mDevice.getProductKey();

【getProductName】
Definition public String getProductName()
Description Gets the product name of the device
Returns Returns the product name of the device
// mDevice is the device object obtained from list of device
sample Code
String productName = mDevice.getProductName();

【getProductType】
Definition public GizWifiDeviceType getProductType()
Description Gets product type, it should be standard or gateway device.
Returns Returns the device type
// mDevice is the device object obtained from list of device
Sample code
GizWifiDeviceType type = mDevice.getProductType();

【getRemark】
Definition public String getRemark()
Description Gets remark of the device. After the device is bound, the remark can be

24
 Android SDK 2.0 API Reference Manual

changed, default is null.

Returns Returns the remark of device.
// mDevice is the device object obtained from list of device
Sample code
String remark = mDevice.getRemark();

【getAlias】
Definition public String getAlias()
Gets the alias of the device. After the device is bound, the alias can be
Description
changed, default is null.
Returns Returns with the alias of the device.
// mDevice is the device object obtained from list of device
Sample code
String alias = mDevice.getAlias();

【getNetStatus】
Definition public GizWifiDeviceNetStatus getNetStatus()
Gets the network status of the device. For details, see the enumeration
Description
GizWifiDeviceNetStatus.
Returns Returns the device’s net state.
// mDevice is the device object obtained from list of device
Sample code
GizWifiDeviceNetStatus netStatus = mDevice. getNetStatus ();

【isLAN】
Definition public boolean isLAN()
Description Determines whether the device is a LAN device or WLAN device.
Returns Returns whether the device is a LAN device or a WLAN device
// mDevice is the device object obtained from list of device
Sample code
boolean isBind = mDevice.isLAN();

【isBind】
Definition public boolean isBind()
Description Determines whether the device has been bound
Returns Returns whether the device has been bound
Sample code // mDevice is the device object obtained from list of device

25
 Android SDK 2.0 API Reference Manual

boolean isBind = mDevice.isBind();

【isDisabled】
Definition public boolean isDisabled()
Description Determines whether the device has been disabled by the cloud.
Returns Determines whether the device has been disabled by the cloud.
// mDevice is the device object obtained from list of device
Sample code
boolean isDisabled = mDevice.isDisabled();

【isSubscribed】
Definition public boolean isSubscribed()
Description Determines whether the device has been subscribed.
Returns Returns whether the device has been subscribed.
// mDevice is the device object obtained from list of device
Sample code
boolean isSubscribed = mDevice.isSubscribed();

【isProductDefined】
Definition public boolean isProductDefined()
Description Determines whether the device has defined datapoint.
Returns Returns whether the device has defined datapoint.
// mDevice is the device object obtained from list of device
Sample code
boolean isProductDefined = mDevice.isProductDefined();

2.3. Callback API

Below are the callback interfaces provided by the GizWifiDevice class. Afterwards, the
definitions of the API will be specified：

• didUpdateNetStatus： Notification of network status change

• didReceiveData： Callback when device receives a status report

• didSetSubscribe： Callback when device is subscribed or unsubscribed

26
 Android SDK 2.0 API Reference Manual

• didSetCustomInfo： Callback when binding information of device has been set

• didGetHardwareInfo： Device hardware information callback

2.4. API
【didUpdateNetStatus】
public void didUpdateNetStatus(GizWifiDevice device,
Callback
GizWifiDeviceNetStatus netStatus)

The callback initiates device reports on the network status changes.

Callback description When the device is reconnected to power on, when it is disconnected, or
when it is controllable, this callback will trigger.

Callback device The GizWifiDevice object which trigger callback

parameters netStatus The net status of the device (Offline, online or controllable)

// mDevice is the entity object obtained from list of device

mDevice.setListener(mListener);

// implement callback
GizWifiDeviceListener mListener = new GizWifiDeviceListener() {
Sample code
@override
public void didUpdateNetStatus(GizWifiDevice device,
GizWifiDeviceNetStatus netStatus) {
}
};

【setSubscribe】
Definition public void setSubscribe(String productSecret, boolean subscribed)
On whether the device is subscribed or unsubscribed. If the device is
subscribed, it means that the user is interested in the push messages of
the device. After subscription, the SDK will automatically sign in and
Description bound the device. After being unsubscribed, the device will automatically
disconnect, but will not automatically be unbound. Usually, subscriptions
will always succeed and the SDK will remember whether the device is
subscribed.
The product secret of device. On the product information
productSecr section found on GizWits Developer Zone
Parameters
et (dev.gizwits.com), the corresponding product key of the
product secret can be found. There is no default value

27
 Android SDK 2.0 API Reference Manual

for this parameters, so developers must input the correct

productSecret.
Whether it is subscribed or unsubscribed. True means
isSubscribed subscribed, while false means the subscription is
cancelled.

public void didSetSubscribe(GizWifiErrorCode result, GizWifiDevice

Callback
device, boolean isSubscribed)
device The GizWifiDevice object which trigger callback
See the definition for GizWifiErrorCode.
GIZ_SDK_SUCCESS means success, all other values
result
Callback are failures. When failed, subscription status will not be
parameters changed.
Whether the device is subscribed or unsubscribed. True
isSubscribed means it has been subscribed, false means it has been
unsubscribed.

// mDevice is the device object obtained from list of device

mDevice.setListener(mListener);
mDevice.setSubscribe(true); // Subscribed Device
mDevice.setSubscribe(false); // Unsubscribed device

// implement callback
GizWifiDeviceListener mListener = new GizWifiDeviceListener() {
@Override
Sample code public void didSetSubscribe(GizWifiErrorCode result,
GizWifiDevice device, boolean isSubscribed) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// When subscription or unsubscription has succeeded.
} else {
// Failure
}
}
};

【getDeviceStatus】
Definition public void getDeviceStatus(List<String> attrs)
Acquires device status. For devices that are subscribed, the device must
be controllable before the status can be acquired. If the device has
Description
variable-length datapoints, you can also search for status of special
datapoint.

28
 Android SDK 2.0 API Reference Manual

special datapoint names, using a String array. The default is null.

By default, SDK will return all datapoint status of a device. If only
Parameters attrs
check special datapoint status, the parameter should be a string
array.

public void didReceiveData(GizWifiErrorCode result, GizWifiDevice

Callback
device, ConcurrentHashMap<String, Object> dataMap, int sn)
The response or report data of device, which couldn’t be analysed by
Callback description SDK, will be processed as transparent data, and the error code will be
GIZ_SDK_SUCCESS.
device The GizWifiDevice object which trigger callback
See the definition for GizWifiErrorCode. GIZ_SDK_SUCCESS
result means it has succeeded, while all others are failures. When in
failure, dataMap is empty.
The data content reported by the device, in dictionary format：
{
"data": [value], // The value is of the
ConcurrentHashMap type, with the content being status key pair
of the device. [Datapoint Name: Value], with the datapoint value
type being the same as the definition on the site
"alerts": [value], // The value is of the
Callback ConcurrentHashMap type, with the content being alert key pair
parameters data of the device. [Datapoint Name: Value], with the datapoint value
type being the same as the definition on the site
"faults": [value], // The value is of the
ConcurrentHashMap type, with the content being fault key pair
of the device. [Datapoint Name: Value], with the datapoint value
type being the same as the definition on the site
"binary": [value], // The value is of the Byte[] type, with
the content being binary data, which is not defined on site.
}
The responded serial number of the command, which should be
the same as the serial number sent by the APP. When the device
sn
answering the query command or reporting data, the serial
number is 0.

// mDevice is the device object obtained from list of device

mDevice.setListener(mListener);
mDevice.getDeviceStatus();
Sample code

// implement callback
GizWifiDeviceListener mListener = new GizWifiDeviceListener() {

29
 Android SDK 2.0 API Reference Manual

@Override
public void didReceiveData(GizWifiErrorCode result,
GizWifiDevice device, ConcurrentHashMap<String, Object>
dataMap, int SN) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// Query success
} else {
// Query failure

}
}
};

【write】
Definition public void write(ConcurrentHashMap<String, Object> data, int sn)
Gives a controlled command to the device. Commands can only be sent
Description
after a subscribed device is in a controllable status.
The parameters are the commands given to the device. This is in
dictionary format, the key-value pair can be input with the
following ways：
• If the device has definitions for its datapoints, one single
sending can be given to multiple datapoints. Keys within a
dictionary should be named its datapoints, and values
should be the datapoint values. Value types have to be the
same as datapoint definitions：
（1）If the datapoint is boolean, input boolean as the value
data type；
（2）If the datapoint is of the numerical type, input int or float
Parameters as the value type；
（3）If the datapoint is of the enum type, input an enumerated
serial number(int type) or an enumerated string(String type)；
（4）If the datapoint is an extended type, input value as a
Byte[] type；
If the device is operated in a transparent format, transparent
commands can only be sent one at a time. The key in the
dictionary is binary, and the value is of Byte[] type.
The serial number of the control command, corresponding to the
sn responded data of the command. When device has confirmed the
command, this SN will be returned.

Callback public void didReceiveData(GizWifiErrorCode result, GizWifiDevice device,

30
 Android SDK 2.0 API Reference Manual

ConcurrentHashMap<String, Object> dataMap, int SN)

The response or report data of device, which couldn’t be analysed by SDK,
Callback description will be treated as transparent data and processed. The error code will be
GIZ_SDK_SUCCESS
device The GizWifiDevice object which trigger callback
See the definition for GizWifiErrorCode. GIZ_SDK_SUCCESS
result means it has succeeded, while all others are failures. When in
failure, dataMap is empty.
The data content uploaded by the device, in dictionary format：
{
"data": [value], // The value is of the
ConcurrentHashMap type, with the content being a status key
pair of the device. [Datapoint Name: Value], with the datapoint
value type being the same as the definition on the site
"alerts": [value], // The value is of the
Callback ConcurrentHashMap type, with the content being a alert key pair
parameters data of the device. [Datapoint Name: Value], with the datapoint value
type being the same as the definition on the site
"faults": [value], // The value is of the
ConcurrentHashMap type, with the content being a fault key pair
of the device. [Datapoint Name: Value], with the datapoint value
type being the same as the definition on the site
"binary": [value], // The value is of the Byte[] type, with
the content being binary data, which is not defined on site.
}
The responded serial number of the command, which should be
the same as the serial number sent by the APP. When the device
SN
answering the query command or reporting data, the serial
number is 0.

// mDevice is the device object obtained from list of device

mDevice.setListener(mListener);

/*
* The following code uses SN as an example. If the application uses a
command serial number SN, SN can be set to the corresponding value.
Sample code
*/
// After a subscribed device is under the controllable state, a light opening
action will be executed.
int SN = 0;
ConcurrentHashMap command = new ConcurrentHashMap<String,
boolean> ();

31
 Android SDK 2.0 API Reference Manual

command.put("LED_OnOff", true);
mDevice.write(command, SN);

// implement callback
GizWifiDeviceListener mListener = new GizWifiDeviceListener() {
@Override
public void didReceiveData(GizWifiErrorCode result,
GizWifiDevice device, ConcurrentHashMap<String, Object>
dataMap, int SN) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// Command serial number matches, the light opening
sequence
} else {
// Light has failed to open
}
}
};

【setCustomInfo】
Definition public void setCustomInfo(String remark, String alias)
Description Changes the remarks and alias. Can only be set after the device is bound.
Changes the remarks. null means not being changed, “” means
remark
an empty string.
Parameters
Changes the alias. null means not being changed, “” means an
alias
empty string.

public void didSetCustomInfo(GizWifiErrorCode result, GizWifiDevice

Callback
device)
device The device object of the targeted alias or remark change.
Callback
parameters See the definition for GizWifiErrorCode. GIZ_SDK_SUCCESS
result
means success, all other values are failures.

// mDevice is the entity object obtained from list of device

mDevice.setListener(mListener);
mDevice.setCustomInfo("your_remark", "your_alias");

Sample code // implement callback

GizWifiDeviceListener mListener = new GizWifiDeviceListener() {
@Override
public void didSetCustomInfo(GizWifiErrorCode result,
GizWifiDevice device) {

32
 Android SDK 2.0 API Reference Manual

if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// Change success
} else {
// Change failure
}
}
};

【getHardwareInfo】
Definition public void getHardwareInfo()
Obtains hardware information. This API can be used with unsubscribed
Description
device, as long as device is under the normal operation mode.

public void didGetHardwareInfo(GizWifiErrorCode result, GizWifiDevice

Callback
device, ConcurrentHashMap<String, String> hardwareInfo)
device The device object which returns the hardware information.
See the definition for GizWifiErrorCode.
result GIZ_SDK_SUCCESS means success, all other values
are failures. When in failure, hardwareInfo is null
Hardware information. Corresponding hardware key-
value pair are：

{
"Wi-Fi HardVersion": [value], // values are of the string
type, and is the devices Wi-Fi hardware version
number

Callback "wifiSoftVersion": [value], // values are of the string

parameters type, and is the device Wi-Fi software version number

hardwareInfo
"wifiFirmwareId": [value], // ID values are of the string
type, and is the device Wi-Fi firmware ID number

"wifiFirmwareVer": [value], // values are of the string

type, and is the device Wi-Fi firmware version number

"mcuHardVersion": [value], // values are of the string

type, and is the device hardware version number

"mcuSoftVersion": [value], // values are of the string

type, and is the device software version number

33
 Android SDK 2.0 API Reference Manual

"productKey": [value], // values are of the string type,

and is the product unique identifier of device
}

// mDevice is the device object obtained from list of device

mDevice.setListener(mListener);
mDevice.getHardwareInfo();

// implement callback
GizWifiDeviceListener mListener = new GizWifiDeviceListener() {
@Override
public void didGetHardwareInfo(GizWifiErrorCode result,
Sample code GizWifiDevice device, ConcurrentHashMap<String, String>
hardwareInfo) {
if (result == GizWifiErrorCode.GIZ_SDK_SUCCESS) {
// Success
} else {
// Failure

}
}
};

34
 Android SDK 2.0 API Reference Manual

3. GizUserInfo Class
3.1. Introduction
GizUserInfo class is provided for developers to get and modify user info.

3.2. Member function

Member
Description
function

UID Type: String. Get UID after user logs in. Provide get method.
username Type: String. Username: phone number or email address. Provide get method
email Type: String. User email address. Provide get method.
phone Type: String. User phone number. Provide get method.
isAnonymous Type: Boolean. Judge whether it is anonymous user. Provide get method.
lang Type: String. User’s language environment. Provide get method.
name Type: String. User’s nickname. Provide get and set methods.
userGender Type: GizUserGenderType. User’s gender. Provide get and set methods.
birthday Type: String. User’s birthday. Provide get and set methods.
address Type: String. User’s home address. Provide get and set methods.
remark Type: String. User’s remark. Provide get and set methods.
Type: String. This variable means the time user binds the device. Provide get
deviceBindTime
methods.

35
 Android SDK 2.0 API Reference Manual

4. GizWifiSSID Class
4.1. Introduction
SSID info class of the route, includes the signal name SSID and signal strength of the Wi-
Fi.

4.2. Member function

Member
Description
function

SSID SSID name: Name could be searched when we connect to a Wi-Fi hotspot.
RSSI Signal strength of the corresponding hotspot. Ranges: 0-100

【getSsid】
Definition public String getSsid()
Get the SSID name of the Wi-Fi. Name could be searched when we connect to
Description
a Wi-Fi hotspot.
Returns SSID name of the Wi-Fi
//mWifiSSID is the SSID class object provided in SDK hotspot list
Sample code
String SSID= mWifiSSID.getSsid();

【getRssi】
Definition public int getRssi()
Description Signal strength of the corresponding hotspot. Ranges: 0-100
Returns SSID name of the Wi-Fi
//mWifiSSID is the SSID class object provided in SDK hotspot list
Sample code
int RSSI= mWifiSSID.getRssi();

36
 Android SDK 2.0 API Reference Manual

5. Enumeration Class Definition

5.1. Introduction
This introduces all enumeration class definition that we use in GizWifiSDK.

5.2. Definition
【GizLogPrintLevel】

Description：printing log level

Enum ID Enum Definition Description

0 GizLogPrintNone Not print any log

1 GizLogPrintI Print error log
2 GizLogPrintII Print debug log
3 GizLogPrintAll Print data log

【GizEventType】

Description：the type of event notification

Enum ID Enum Definition Description

0 GizEventSDK SDK system event

1 GizEventDevice device exception event
2 GizEventM2MService M2M exception event
5 GizEventToken Token invalid event

【GizWifiConfigureMode】

Description：device configuration mode

Enum ID Enum Definition Description

0 GizWifiSoftAP SoftAP configuration mode

1 GizWifiAirLink AirLink configuration mode

37
 Android SDK 2.0 API Reference Manual

【GizWifiDeviceType】

Description：device type

Enum ID Enum Definition Description

0 GizDeviceNormal Normal device

1 GizDeviceCenterControl Center control device

【GizThirdAccountType】

Description：the type of third-party account

Enum ID Enum Definition Description

0 GizThirdBAIDU BAIDU account

1 GizThirdSINA SINA account
2 GizThirdQQ QQ account

【GizWifiDeviceNetStatus】

Description：the type of device net status

Enum ID Enum definition Description

0 GizDeviceOffline Offline
1 GizDeviceOnline Online
2 GizDeviceControlled Controlled

【GizWifiGAgentType】

Description：the type of module

Enum ID Enum Definition Description

0 GizGAgentMXCHIP MXChip 3162 module

1 GizGAgentHF HF module
2 GizGAgentRTK RTK module
3 GizGAgentWM WM module
4 GizGAgentESP ESP module

38
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

5 GizGAgentQCA Qualcomm module

6 GizGAgentTI TI module
7 GizGAgentFSK FSK module
8 GizGAgentMXCHIP3 MXChip V3 module
9 GizGAgentBL BL module
10 GizGAgentAtmelEE Atmel module
11 GizGAgentOther Other module

【GizUserGenderType】

Description：user’s gender

Enum ID Enum Definition Description

0 GizUserGenderMale Male

1 GizUserGenderFemale Female

2 GizUserGenderUnknown Unknow

【GizWifErrorCode】
Description: error code definition

Enum ID Enum Definition Description

0 GIZ_SDK_SUCCESS SDK runs successfully

The format of SDK internal
8001 GIZ_SDK_PARAM_FORM_INVALID
param is invalid
8002 GIZ_SDK_CLIENT_NOT_AUTHEN SDK is not started yet
8003 GIZ_SDK_CLIENT_VERSION_INVALID SDK version is invalid
8004 GIZ_SDK_UDP_PORT_BIND_FAILED UDP port binding failed
Catch exception when
8005 GIZ_SDK_DAEMON_EXCEPTION
execute SDK daemon
8006 GIZ_SDK_PARAM_INVALID SDK param is invalid
8007 GIZ_SDK_APPID_LENGTH_ERROR AppID length error
8008 GIZ_SDK_LOG_PATH_INVALID SDK log file path is invalid
8009 GIZ_SDK_LOG_LEVEL_INVALID The log level is invalid

39
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

There‘s no available device

8020 GIZ_SDK_NO_AVAILABLE_DEVICE
to set server info
Device's Wi-Fi config info
8021 GIZ_SDK_DEVICE_CONFIG_SEND_FAILED
sending failed
Device's Wi-Fi config is
8022 GIZ_SDK_DEVICE_CONFIG_IS_RUNNING
running
Device's Wi-Fi config
8023 GIZ_SDK_DEVICE_CONFIG_TIMEOUT
timeout
8024 GIZ_SDK_DEVICE_DID_INVALID DID is invalid
8025 GIZ_SDK_DEVICE_MAC_INVALID MAC is invalid
8026 GIZ_SDK_SUBDEVICE_DID_INVALID The sub device is invalid
8027 GIZ_SDK_DEVICE_PASSCODE_INVALID The passcode is invalid
8028 GIZ_SDK_DEVICE_NOT_CENTERCONTROL The device is not central
8029 GIZ_SDK_DEVICE_NOT_SUBSCRIBED Device is not subscribed yet
8030 GIZ_SDK_DEVICE_NO_RESPONSE No response from device
8031 GIZ_SDK_DEVICE_NOT_READY Device is not ready
8032 GIZ_SDK_DEVICE_NOT_BINDED Device is not bound yet
GIZ_SDK_DEVICE_CONTROL_WITH_INVALID_ Device control command is
8033
COMMAND with invalid command
8034 GIZ_SDK_DEVICE_CONTROL_FAILED Failed to controll device
8035 GIZ_SDK_DEVICE_GET_STATUS_FAILED Failed to get device status
GIZ_SDK_DEVICE_CONTROL_VALUE_TYPE_E The command param type
8036
RROR is error
GIZ_SDK_DEVICE_CONTROL_VALUE_OUT_OF The command param value
8037
_RANGE is out of range
GIZ_SDK_DEVICE_CONTROL_NOT_WRITABLE Device control command is
8038
_COMMAND with not writable command
8039 GIZ_SDK_BIND_DEVICE_FAILED Device binding failed
8040 GIZ_SDK_UNBIND_DEVICE_FAILED Device unbinding failed
8041 GIZ_SDK_DNS_FAILED DNS parsing failed
Connect to M2M
8042 GIZ_SDK_M2M_CONNECTION_SUCCESS
successfully
Socket non-blocking setting
8043 GIZ_SDK_SET_SOCKET_NON_BLOCK_FAILED
failed

40
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

8044 GIZ_SDK_CONNECTION_TIMEOUT Connection timeout

8045 GIZ_SDK_CONNECTION_REFUSED Connection is refused
8046 GIZ_SDK_CONNECTION_ERROR Connection error occurred
Connection is cloesed by
8047 GIZ_SDK_CONNECTION_CLOSED
peer
8048 GIZ_SDK_SSL_HANDSHAKE_FAILED SSL handshake failed
8049 GIZ_SDK_DEVICE_LOGIN_VERIFY_FAILED Device login verifying failed
8050 GIZ_SDK_INTERNET_NOT_REACHABLE The Internet is unreachable
Cloud Service does not
8095 GIZ_SDK_HTTP_SERVER_NOT_SUPPORT_API
support the API
HTTP response data format
8096 GIZ_SDK_HTTP_ANSWER_FORMAT_ERROR
error
HTTP response parameter
8097 GIZ_SDK_HTTP_ANSWER_PARAM_ERROR
error
No response from HTTP
8098 GIZ_SDK_HTTP_SERVER_NO_ANSWER
server
8099 GIZ_SDK_HTTP_REQUEST_FAILED HTTP request failed
8100 GIZ_SDK_OTHERWISE Reserved error
8101 GIZ_SDK_MEMORY_MALLOC_FAILED Memory allocation failed
8102 GIZ_SDK_THREAD_CREATE_FAILED Thread creation failed
The config file of device
8201 GIZ_SDK_DATAPOINT_NOT_DOWNLOAD datapoint is not yet
downloaded
GIZ_SDK_DATAPOINT_SERVICE_UNAVAILABL Config service of device
8202
E datapoint is unavailable
Device datapoint parsing
8203 GIZ_SDK_DATAPOINT_PARSE_FAILED
failed
8300 GIZ_SDK_SDK_NOT_INITIALIZED SDK is not initialized yet
Android context is null,
8301 GIZ_SDK_APK_CONTEXT_IS_NULL
unable to start SDK
The permission for SDK is
8302 GIZ_SDK_APK_PERMISSION_NOT_SET
not set
Refused to change
8303 GIZ_SDK_CHMOD_DAEMON_REFUSED
permission of SDK daemon

41
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

Failed to execute SDK

8304 GIZ_SDK_EXEC_DAEMON_FAILED
daemon
Catch exception when
8305 GIZ_SDK_EXEC_CATCH_EXCEPTION
execute SDK daemon
AppID is null, unable to use
8306 GIZ_SDK_APPID_IS_EMPTY
SDK
This API has been
8307 GIZ_SDK_UNSUPPORTED_API discarded and no longer
provide support
8308 GIZ_SDK_REQUEST_TIMEOUT request timeout
SDK daemon version is
8309 GIZ_SDK_DAEMON_VERSION_INVALID
invalid
GIZ_SDK_PHONE_NOT_CONNECT_TO_SOFTA Phone do not connect the
8310
P_SSID SoftAp SSID
The current Wi-Fi network is
GIZ_SDK_DEVICE_CONFIG_SSID_NOT_MATC not matched the device
8311
HED onboarding SSID, unable to
connect device with network
Device is not in SoftAP
8312 GIZ_SDK_NOT_IN_SOFTAPMODE
mode
The phone Wi-Fi is
8313 GIZ_SDK_PHONE_WIFI_IS_UNAVAILABLE
unavailable
The current mode is raw
8314 GIZ_SDK_RAW_DATA_TRANSMIT data transparent
tranmission
Downloading config file of
8315 GIZ_SDK_PRODUCT_IS_DOWNLOADING
device datapoint
8316 GIZ_SDK_START_SUCCESS SDK started successfully

9001 GIZ_OPENAPI_MAC_ALREADY_REGISTERED MAC already registered!

9002 GIZ_OPENAPI_PRODUCT_KEY_INVALID product_key invalid
9003 GIZ_OPENAPI_APPID_INVALID appid invalid
9004 GIZ_OPENAPI_TOKEN_INVALID token invalid
9005 GIZ_OPENAPI_USER_NOT_EXIST user not exist
9006 GIZ_OPENAPI_TOKEN_EXPIRED token expired
9007 GIZ_OPENAPI_M2M_ID_INVALID m2m_id invalid

42
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

9008 GIZ_OPENAPI_SERVER_ERROR server error

9009 GIZ_OPENAPI_CODE_EXPIRED code expired
9010 GIZ_OPENAPI_CODE_INVALID code invalid
GIZ_OPENAPI_SANDBOX_SCALE_QUOTA_EX sandbox scale quota
9011
HAUSTED exhausted!
GIZ_OPENAPI_PRODUCTION_SCALE_QUOTA_ production scale quota
9012
EXHAUSTED exhausted!
GIZ_OPENAPI_PRODUCT_HAS_NO_REQUEST product has no request
9013
_SCALE scale!
9014 GIZ_OPENAPI_DEVICE_NOT_FOUND device not found!
9015 GIZ_OPENAPI_FORM_INVALID form invalid!
9016 GIZ_OPENAPI_DID_PASSCODE_INVALID DID or passcode invalid!
9017 GIZ_OPENAPI_DEVICE_NOT_BOUND device not bound!
9018 GIZ_OPENAPI_PHONE_UNAVALIABLE phone unavailable!
9019 GIZ_OPENAPI_USERNAME_UNAVALIABLE username unavailable!
GIZ_OPENAPI_USERNAME_PASSWORD_ERR username or password
9020
OR error!
9021 GIZ_OPENAPI_SEND_COMMAND_FAILED send command failed!
9022 GIZ_OPENAPI_EMAIL_UNAVALIABLE email unavailable!
9023 GIZ_OPENAPI_DEVICE_DISABLED device is disabled!
9024 GIZ_OPENAPI_FAILED_NOTIFY_M2M fail to notify m2m!
9025 GIZ_OPENAPI_ATTR_INVALID attr invalid!
9026 GIZ_OPENAPI_USER_INVALID user invalid!
9027 GIZ_OPENAPI_FIRMWARE_NOT_FOUND firmware not found!

9028 GIZ_OPENAPI_JD_PRODUCT_NOT_FOUND JD product info not found!

GIZ_OPENAPI_DATAPOINT_DATA_NOT_FOUN
9029 datapoint data not found!
D
9030 GIZ_OPENAPI_SCHEDULER_NOT_FOUND scheduler not found!
9031 GIZ_OPENAPI_QQ_OAUTH_KEY_INVALID qq oauth key invalid!
GIZ_OPENAPI_OTA_SERVICE_OK_BUT_IN_IDL ota upgrade service OK, but
9032
E in idle or disable!
bt firmware unverified,
9033 GIZ_OPENAPI_BT_FIRMWARE_UNVERIFIED
except verify device!

43
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

GIZ_OPENAPI_BT_FIRMWARE_NOTHING_TO_ bt firmware is OK, but

9034
UPGRADE nothing to upgrade!
9035 GIZ_OPENAPI_SAVE_KAIROSDB_ERROR Save kairosdb error!
9036 GIZ_OPENAPI_EVENT_NOT_DEFINED event not defined!
9037 GIZ_OPENAPI_SEND_SMS_FAILED send sms failed!
X-Gizwits-Application-Auth
9038 GIZ_OPENAPI_APPLICATION_AUTH_INVALID
invalid!
Not allowed to call
9039 GIZ_OPENAPI_NOT_ALLOWED_CALL_API
deprecated API!
9040 GIZ_OPENAPI_BAD_QRCODE_CONTENT bad qrcode content!
9041 GIZ_OPENAPI_REQUEST_THROTTLED request was throttled
9042 GIZ_OPENAPI_DEVICE_OFFLINE device offline!
'X-Gizwits-Timestamp
9043 GIZ_OPENAPI_TIMESTAMP_INVALID
invalid!
9044 GIZ_OPENAPI_SIGNATURE_INVALID X-Gizwits-Signature invalid!
9045 GIZ_OPENAPI_DEPRECATED_API API deprecated!
Register already in
9046 GIZ_OPENAPI_REGISTER_IS_BUSY
progress!
9080 GIZ_OPENAPI_CANNOT_SHARE_TO_SELF can not share device to self!
guest or normal user can not
9081 GIZ_OPENAPI_ONLY_OWNER_CAN_SHARE
share device!
9082 GIZ_OPENAPI_NOT_FOUND_GUEST guest user not found!
9083 GIZ_OPENAPI_GUEST_ALREADY_BOUND guest user alread bound!
9084 GIZ_OPENAPI_NOT_FOUND_SHARING_INFO sharing record not found!
9085 GIZ_OPENAPI_NOT_FOUND_THE_MESSAGE message record not found!
sharing alread created,
GIZ_OPENAPI_SHARING_IS_WAITING_FOR_A
9087 waiting for the guest to
CCEPT
accept!
9088 GIZ_OPENAPI_SHARING_IS_EXPIRED sharing record expired!
sharing record status is not
9089 GIZ_OPENAPI_SHARING_IS_COMPLETED
unaccept!
GIZ_OPENAPI_INVALID_SHARING_BECAUSE_ owner binding disabled!
9090
UNBINDING
9092 GIZ_OPENAPI_ONLY_OWNER_CAN_BIND owner exist, guest can not

44
 Android SDK 2.0 API Reference Manual

Enum ID Enum Definition Description

bind!
permission denied, you are
9093 GIZ_OPENAPI_ONLY_OWNER_CAN_OPERATE
not owner!
GIZ_OPENAPI_SHARING_ALREADY_CANCELL
9094 sharing already canceled!
ED
GIZ_OPENAPI_OWNER_CANNOT_UNBIND_SE
9095 can not unbind self!
LF
GIZ_OPENAPI_ONLY_GUEST_CAN_CHECK_Q permission denied, you are
9096
RCODE not guest!
GIZ_OPENAPI_MESSAGE_ALREADY_DELETE
9098 notify delele binding failed!
D
9099 GIZ_OPENAPI_BINDING_NOTIFY_FAILED notify delele binding failed!
GIZ_OPENAPI_ONLY_SELF_CAN_MODIFY_ALI permission denied, you are
9100
AS not owner or guest!
GIZ_OPENAPI_ONLY_RECEIVER_CAN_MARK_ permission denied, you are
9101
MESSAGE not the receiver!
9999 GIZ_OPENAPI_RESERVED reserved

45