Updating the Device Status
API Function
This API is used to update status information about devices, including directly connected devices and indirectly connected devices managed by the IoT platform. The device status can be updated through this API when the device is offline or online.
The status of directly connected devices is updated based on the device connection status. If a directly connected device is disconnected from the IoT platform, its status becomes offline. If a directly connected device is connected or reconnected to the IoT platform, its status becomes online and does not need to be updated through this API. Therefore, it is recommended that you call this API to update the status of indirectly connected devices.
API Description
1 | public static boolean updateDeviceStatus(int cookie, String deviceId, String status, String statusDetail);
|
Class
HubService
Parameter Description
| Parameter | Mandatory or Optional | Type | Description |
|---|---|---|---|
| cookie | Optional | int | The value ranges from 1 to 65535. |
| deviceId | Mandatory | String | Identifier of a device. |
| status | Mandatory | String | Status of the device.
|
| statusDetail | Mandatory | String | Provides the detailed device status information.
|
Return Value
| Return Value | Description |
|---|---|
| true | Success |
| false | Failure |
Return values only show API calling results. For example, the return value true indicates that the API is called successfully but does not indicate that the device status is updated successfully. The device status is updated successfully only after the HubService broadcast is received.
Example
Call this API to update the device status.
1 | HubService.deviceStatusUpdate(0, deviceId, "ONLINE", "NONE");
|
Implement the observer API provided by the AgentLite before calling this API.
1 2 3 4 5 | public class Subscribe implements MyObserver {
public Subscribe (Observable hubService) {
hubService. registerObserver (this);
}
@Override Same as those used for adding a device.
|
Last Article: Adding a Device
Next Article: Deleting a Device
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.