1.1. Main class introduction
1.1.1. JdSmartAccount
Provide user login to intelligent host. The `setName()` function indicates the current logged-in username. If the login is successful, it assigns a value; if the login is exited, it sets it to an empty string `""`.
1.1.2. JdSmartHostInfo
//Set whether user login is supported, if supported write true, the system provides a login page (Desktop - Settings - Account Import, enter the login page), otherwise false (such as scanning the QR code for login created by this plugin application)
void setSupportLogin(boolean supportLogin)
//Login prompt information, it is recommended to write the brand name
void setLoginPrompt(String loginPrompt)
//Set whether to enable scene editing, default is true
void setEnableSceneEdit(boolean enable)
//Does it support viewing alarm records of sensor devices
void setShowSensorDetail(boolean showSensorDetail)
//Does it support selecting a family
void setEnableSelectFamily(boolean enableSelectFamily)
//Set the current selected family name
void setCurFamilyName(String curFamilyName)
//Set login type
void setLoginType(String loginType)
//Set relevant parameters for login, which can be optional if not set
void setLoginParas(JdSmartLoginParas loginParas)
//Set the version number, it can be directly set to 3
void setVersion(int version)
1.1.3. JdSmartDevice
Abstract representation of an intelligent device
//Device Unique Identifier
setDeviceId()
//Device type
setDeviceType()
//Device Subtype - If the device is an infrared device, it needs to be set as a subtype of JdSmartDeviceType.DEVICE_SUB_TYPE_IR
setDeviceSubType()
/*
* If it is an infrared device, set the list of infrared keys that this device has learned, with key * * *separators as ","
* For example, the TV has learned to turn on and off, and the mute button is called like thissetJdIRkeyList(JdSmartIRConstant.IR_KEY_TV_ON+"," + JdSmartIRConstant.IR_KEY_TV_OFF+"," + JdSmartIRConstant.IR_KEY_TV_MUTE +",");
*/
setJdIRkeyList()
//Device Name
setDeviceName()
//A JdSmartCtrlCmd variable will be returned to indicate the current status of the device, for details see the JdSmartCtrlCmd class
getJdSmartCtrlCmd()
1.1.4. JdSmartCtrlCmd
Through deviceId to associate with a specific JdSmartDevice, the JdSmartDevice class also contains the JdSmartCtrlCmd class
This Class includes variables such as order, value1, value2, value3, value4, and groupData
There are two meanings
- Commands for smart devices, generally refer to receiving device control commands or scene execution commands
- Equipment current status, indicating the current status when the latest status of the equipment is updated to the UI end.
For more details, see the demo code in the CustomSmartHost.java code function
void controlDevice(JdSmartCtrlCmd cmd, JdbaseCallback callback)
void changeDeviceStatus(JdSmartCtrlCmd cmd, JdSmartDevice dev)
If a device control command or scene execution command is received, the following is indicated:
order represents a command, details see JdSmartDeviceOrder class
value1, value2, value3, value4 represent the parameters carried by this command
groupData is a JSON string, if the device command is complex, multiple parameter values can be passed using groupData at once
For example:
Received the turn on command:JdSmartCtrlCmd.getOrder() Will equal JdSmartDeviceOrder.ON JdSmartCtrlCmd.getValue1()
Received the command to set the air conditioner to the next mode:
JdSmartCtrlCmd.getOrder() Will equal JdSmartDeviceOrder.NEXT
JdSmartCtrlCmd.getValue1()Will equal AIRCONDITION_MODE_TYPE
Update the latest status of the device to the UI, it is not necessary to handle the JdSmartCtrlCmd.order member variable, as indicated below:
value1 to value4 indicate the current status of this device
groupData is a JSON string, if the device command is complex, multiple values can be passed using groupData at once
For example: Update the current status of the light to on:JdSmartCtrlCmd.setValue1("0")
Update the air conditioner to cooling mode, high wind speed, sweeping left and right before, temperature 28:
JSONObject jobj = new JSONObject();
jobj.put(JdSmartDeviceOrder.AIRCONDITION_MODE_TYPE, JdSmartDeviceOrder.AIRCONDITION_MODE_COOL);
jobj.put(JdSmartDeviceOrder.AIRCONDITION_WIND_RATE_TYPE, JdSmartDeviceOrder.AIRCONDITION_WIND_RATE_LOW);
jobj.put(JdSmartDeviceOrder.AIRCONDITION_WIND_DIRECTION_TYPE, JdSmartDeviceOrder.AIRCONDITION_WIND_DIRECTION_LEFT_RIGHT);
jobj.put(JdSmartDeviceOrder.TEMPERATURE, "28");
airConditionCmd.setGroupData(jobj.toJSONString());
1.1.5. JdSmartDeviceType
Including switches, ordinary lights, dimmable lights, curtains, power outlets, air conditioners, televisions, air purifiers, window openers, thermostats, multi-functional control boxes, various sensors
Note:
DEVICE_TYPE_CURTAINS Indicates curtains that can accurately obtain the moving position
DEVICE_TYPE_CURTAINS_NO_POSITION Indicates that the exact position of the curtains cannot be accurately obtained
1.1.6. JdSmartDeviceOrder
- ON, OFF, light, switch, socket, etc., on and off of simple devices
- OPEN, CLOSE, MOVE_TO_LEVEL curtain, air conditioner, air purifier, window opener, thermostat on/off
- MOVE_TO_LEVEL, PAUSE, STOP indicate position movement, the total is 100, for example, opening curtains is 50, for air conditioning, MOVE_TO_LEVEL adjusts the temperature
- NEXT Switch to the next mode of the device. The air conditioning device directly switches to the next working mode, wind speed level, or wind direction.
- Set the value of a specific attribute of the device
- MUTE Mute the device that is alarming
1.1.7. JdSmartScene
Represents scene type, with a unique sceneNo to identify the scene
- getSceneNo() and setSceneNo() // Get and set the scene number
- getSceneId() and setSceneId() // Deprecated, not recommended for use
1.1.8. JdSmartSceneBind
Indicates scene binding, its member variable sceneNo is associated with the sceneNo of the JdSmartScene class
The meaning of scene binding is what device commands are included in the scene.
For example, suppose there is a homecoming scene that includes actions, such as turning on the living room lights, turning on the TV, and opening the master bedroom space after the host returns home
Then it will include 4 commands, the List getCmdList() will return 4 data commands
1.1.9. IJdSmartHost
Host-related interfaces
//Obtain host information
JdSmartHostInfo getHostInfo()
//Search and bind the host
void searchAndBindHost(boolean isSearch, JdbaseCallback callback)
// Unbind
void unbindHost(JdbaseCallback callback)
Log in related interfaces
//Retrieve login account information
JdSmartAccount getAccount()
//login
void login(String name, String pwd, JdbaseCallback callback)
//Log out
void logout(JdbaseCallback callback)
//Get current login status
String getLoginState()
//Set current login status
setLoginState(int state, String msg)
Scene-related
//Execute scene
void controlScene(JdSmartScene jdsmartScene, JdbaseCallback callback)
//Get all scenes
void getScenes(JdbaseCallback callback)
Scene music related
The usage scenario is as follows: when the mobile app executes a scene, the background music needs to play the corresponding scene music. If the background music can receive notifications of the mobile app scene execution, this interface can be called in the integration package to play the scene music corresponding to the scene number.
//According to the scene ID, play the corresponding scene music
void playSceneMusicFromSys(String sceneNo)
Equipment-related
//Refresh the device, during synchronization, this function method will be called first
void refeshDevice()
//Execute device command
void controlDevice(JdSmartCtrlCmd cmd, JdbaseCallback callback)
//Get all device information
void getAllDevices(JdbaseCallback callback)
//Update device status
void registerDeviceChange(JdbaseCallback callback)
//Get storage records of sensor type devices
void getSensorRecord(String deviceid, int pageIndex, int pageSize, JdbaseCallback callback)
1.1.10. CustomSmartService
CustomSmartService.java is a service class for communicating with other Jd software services and does not require any modifications.
Firstly, configure the action name for the CustomSmartService.java service in AndroidManifest.xml
<action android:name="com.judian.service.CustomSmartService" /> //Please do not change this because the SDK end depends on it
<service
android:name=".service.CustomSmartService"
android:exported="true">
<intent-filter>
<action android:name="com.judian.service.CustomSmartService" />
</intent-filter>
</service>
1.1.11. CustomSmartHost
CustomSmartHost.java is the final implementation class, implementing the IJdSmartHost.java interface. Customers should implement the corresponding interface methods according to their own SDK, with the focus on this file.
void init(Context context)
After the program runs, the init function will be called. The initialization code can be searched on the host. The code for the second login to the host (the first login was successful, and the username was saved; logged in again after the computer was restarted) should be written here. After successfully logging into the host, it is recommended to immediately obtain the device list to reduce network latency
//Initialization section, when the program runs, set the information of this plug-in
void init(Context context);
JdSmartHostInfo getHostInfo()
Return a JdSmartHostInfo indicating the functions supported by the host
/**
* Get host information, configure JdSmartHostInfo class required
*
* @return JdSmartHostInfo Return host information
*/
JdSmartHostInfo getHostInfo();
void login(String name, String pwd, JdbaseCallback callback)
Support login, the user needs to implement it, otherwise return success directly, callback.onResult(JdbaseContant.RESULT_SUCCESS, "success", "");
/**
* User authentication login
* For example:
* Success callback.onResult(JdbaseContant.RESULT_SUCCESS, "success", "");
* Fail callback.onResult(JdbaseContant.RESULT_FAIL, "fail", "");
* @param name Username
* @param pwd Password
* @param callback Callback login result
*/
void login(String name, String pwd, JdbaseCallback callback);
JdSmartAccount getAccount()
Return JdSmartAccount information. If login is not supported, JdSmartAccount.name should be set to “”, if not logged in, JdSmartAccount.name should be set to "", otherwise set it to the current logged-in username, indicating that the user is logged in.
/**
* Get information of logged-in account
* @return If not logged in, JdSmartAccount.name should be set to "", otherwise set it to the current *logged-in username, indicating that the user is logged in.
*/
JdSmartAccount getAccount();
private void setLoginState(int state, String msg)
Set current login status
void logout(JdbaseCallback callback)
Support login, the user needs to implement it, otherwise return success directly, callback.onResult(JdbaseContant.RESULT_SUCCESS, "success", "");
/**
* Log out
*<pre>
*For example:
* Success callback.onResult(JdbaseContant.RESULT_SUCCESS, "success", "");
* Fail callback.onResult(JdbaseContant.RESULT_FAIL, "fail", "");
*</pre>
* @param callback Callback Log out information
*
*/
void logout(JdbaseCallback callback);
public void selectFamily(String familyID, JdbaseCallback callback)
Select a family to display all devices under the family
void getScenes(JdbaseCallback callback)
Retrieve all scene information, which is returned as a JSON string.
/**
* Get all scenes
* <pre>
* For example:
* JdSmartScenes jss = new JdSmartScenes();
* for(Scenexxxx s: list){
* JdSmartScene js = new JdSmartScene();
* js.setSceneNo(s.getNo());
* js.setSceneId(s.getId()+"");
* js.setSceneName(s.getName());
* js.setVendor(xxxxx);
* jss.addScene(js);
* }
* callback.onResult(JdbaseContant.RESULT_SUCCESS, JSON.toJSONString(jss), "");
* </pre>
* @param callback Callback result
*
*/
void getScenes(JdbaseCallback callback);
void getAllDevices(JdbaseCallback callback)
Obtain all devices
/**
* Get a list of all devices
* <pre>
* For example:
* JdSmartDevices jds = new JdSmartDevices();
* JdSmartDevice device1 = new JdSmartDevice();
* JdSmartDevice device2 = new JdSmartDevice();
* jds.addDevice(device1);
* jds.addDevice(device2);
* callback.onResult(JdbaseContant.RESULT_SUCCESS, JSON.toJSONString(jds), "");
* </pre>
* @param callback Callback result
*/
void getAllDevices(JdbaseCallback callback);
void controlDevice(JdSmartCtrlCmd cmd, JdbaseCallback callback)
Control the device, in the cmd, order indicates the operation command to be executed, and value1, value2, value3, value4 represent the command parameters
/**
* Control device
* <pre>
* For example:
* callback.onResult(JdbaseContant.RESULT_SUCCESS, "success", "");
* callback.onResult(JdbaseContant.RESULT_FAIL, "fail", "");
* </pre>
* @param cmd device command
* @param callback Callback result
*/
void controlDevice(JdSmartCtrlCmd cmd, JdbaseCallback callback);
void controlScene(JdSmartScene jdsmartScene, JdbaseCallback callback)
Control scene
/**
* Control scene
* <pre>
* For example：
* callback.onResult(JdbaseContant.RESULT_SUCCESS, "success", "");
* callback.onResult(JdbaseContant.RESULT_FAIL, "fail", "");
* </pre>
* @param jdsmartScene Scene class
* @param callback Callback result
*/
void controlScene(JdSmartScene jdsmartScene, JdbaseCallback callback);
void getSensorRecord(String deviceid, int pageIndex, int pageSize, JdbaseCallback callback)
Retrieve the content of the sensor records, as the content may be extensive, so data is returned based on page index and page size
/**
* Get the content recorded by the sensor
* <pre>
* For example：
* List<JdSmartSensorRecordGroup> result = new ArrayList<JdSmartSensorRecordGroup>();
* JdSmartSensorRecord record1 = new JdSmartSensorRecord();
* JdSmartSensorRecord record2 = new JdSmartSensorRecord();
* result.add(record1);
* result.add(record2);
* callback.onResult(JdbaseContant.RESULT_SUCCESS, JSON.toJSONString(result), "");
* </pre>
* @param deviceid Device ID
* @param pageIndex Page number, starting from 1
* @param pageSize The number of items per page
* @param callback Callback result
*/
void getSensorRecord(String deviceid, int pageIndex, int pageSize, JdbaseCallback callback);
void registerDeviceChange(JdbaseCallback callback)
When there is a change in device information, upload device information through callback
/**
* When there is a change in device information, the callback should be called
* For example：
* callback.onResult(JdSmartConstant.ACTION_REPORT_DEVICE_STATUS,JSON.toJSONString(jdSmartDevice), "")
* @param callback Responsible for calling back new device information to the upper layer
*/
void registerDeviceChange(JdbaseCallback callback);