String apiUri = "https://XXX.XXXXX.XXX/api/v1/XXXX";
String accessId = "XXXXXXXXX";
String accessKey = "XXXXXXXXXXXXXXXXXXXXXXXXXX";
// 1.Create WhatieCloudClient
WhatieCloudClient client = new WhatieCloudClient(accessId, accessKey, apiUri);
// 2.Create new request object
RequestMessage request = new RequestMessage();
// (1) Set api and apiVersion
request.setApi(apiUri);
// The apiVersion:/api/v1 -> "1.0", /api/v2 -> "2.0"
request.setApiVersion("1.0");
// (2) The default language is "en-us"
request.setLang(Const.MessageConst.LANG_EN);
//request.setLang(Const.MessageConst.LANG_CN);
// 3.Create parameters via HashMap
Map<String, String> params = new HashMap<>();
params.put("XXXX", "145");
params.put("accessId", "XXXXXXXXX");
params.put("accessKey", "XXXXXXXXXXXXXXXXXXXXXXXXXX");
// 4.Set parameters
request.setParams(params);
// 5.Send request and receive response
ResponseMessage response = client.sendRequest(request);
if (response.isSuccess()) {
// The request succeeds. Now check the result from the json object
// Note: the JSONObject object method is imported from com.alibaba.fastjson.JSONObject
String result = JSONObject.toJSONString(response, true);
System.out.println(result);
} else {
// The request fails. Please check the errorCode and errorMessage
int errorCode = response.getCode();
String errorMsg = response.getMessage();
System.out.println(errorMsg);
}-
Requirements: The accessId and accessKey should be applied from ATI.
-
The ClientConfig could be customized:
ClientConfig clientConfig = new ClientConfig(); clientConfig.setConnectionTimeout(10000); clientConfig.setSocketTimeout(10000); clientConfig.setMaxConnections(100); clientConfig.setMaxErrorRetry(5); WhatieCloudClient client = new WhatieCloudClient(accessId, accessKey, apiUri, clientConfig);
The ClientConfig's default values:
SOCKET_TIMEOUT = 50000; CONNECTION_TIMEOUT = 50000; MAX_ERROR_RETRY = 3; MAX_CONNECTIONS = 50;
-
Dependency:
If you encounter conflict in your project because of .jar file while using WhatieSDK.jar, please use WhatieSDK-WD.jar instead, and then please add the following Maven dependencies or import the jar file in your project.
<dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.6</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.2.49</version> </dependency>
Attention
- The deviceId is different from devId, both of them are returned in the Device List API(The deviceId is an Integer value while devId is a String value.). And, IMPORTANT: both of them are used in other API without changing their names, i.e., keeping the names 'deviceId' or 'devId', in other API!!!
-
Request
URL TYPE PARAMS Description https://users.whatie.net/api/v1/login POST email password user password MD5 hashed -
Response
If success, the user id would be returned in the data.
{ "code":0, "data":459, "success":true }
-
Request
URL TYPE PARAMS Description https://devices.whatie.net/api/v1/deviceList POST customerId user id, from user login request -
Response
Attention
- The deviceId is different from devId: deviceId(Integer), devId(String)
- The typeName represents Device Type which could be "Plug" or "RgbLight" so far (2018.8.27) , and typeId which you may not use right now.
{ "code":0, "data":[ { "devId":"0123456abc", // String value "dps":{ "light":"false", "power":"false" }, "name":"269846", "typeName":"Plug", "online":true, "deviceId":269846, // Integer value "typeId":3, "room":"defaultRoom" } ], "success":true }
-
Request
URL TYPE PARAMS Description https://msg.whatie.net/api/v1/changeDps POST devId dps - dps example:
-
Plug:
turn on(all true)/turn off(all false)
{ "dps": { "1": true, "2": true } } -
RgbLight:
Attention:
The dps of light mode has a key "l" which is lowercase of "L", no number "1".
The light's dps only lightMode is Integer value and which has a fixed value in every light mode , the others are all String values which could be set as needed.
- lightMode1: adjust the brightness value of light
{ "dps": { "l": "25", // brightness value "lightMode": 1 // fixed value } }- lightMode2: change the color of light via RGB value, l is the brightness value
{ "dps": { "l": "35", // brightness value "lightMode": 2, // fixed value "rgb": "255_237_228" // rgb value } }- lightMode4: turn on/off light, on -> true/ off -> false
{ "dps": { "lightMode": 4, // fixed value "status": "false" } }- lightMode5(StreamLight): rgb1/2/3/4 are four kinds of color's RGB values that you want light to change , and l is the brightness value, t is interval(ms) of StreamLight which 1000 is recommended.
{ "dps": { "l": "35", // brightness value "lightMode": 5, // fixed value "rgb1": "255_221_123", // rgb value one "rgb2": "22_145_56", // rgb value two "rgb3": "146_237_97", // rgb value three "rgb4": "46_189_228", // rgb value four "t": "1000" // interval value } }
-
- dps example:
-
Response
{ "code": 0, "success": true }
Attention
The timerId would not return in this API. If you need the timerId, please get it by List Timer Task.
-
Request
URL TYPE PARAMS Description https://msg.whatie.net/api/v1/setTimer POST deviceId device id(ex:123456) timerType eg.0000001 only Monday every week, 1000000 only Sunday every week, 0000000 Only once finishTime Current time, eg. 10:15 -> 1015, 00:01 -> 0001 dps dps example see Publish New Dps API timezone Timezone, eg.+800, Beijing customerId -
Response
{ "code":0, "success":true }
-
Request
URL TYPE PARAMS Description https://msg.whatie.net/api/v1/removeTimer POST timerId customerId -
Response
{ "code":0, "success":true }
-
Request
URL TYPE PARAMS Description https://msg.whatie.net/api/v1/timerList POST devId -
Response
{ "code":0, "data":[ { "finishTime":"225", "timerType":"0000000", "clockId":0, "dps":{ "1":true, "2":true }, "clockStatus":true, "timerId":930 }, { "finishTime":"1801", "timerType":"0000000", "clockId":1, "dps":{ "1":true, "2":true }, "clockStatus":true, "timerId":931 } ], "success":true }