setLEDIndicatorStatus (v1.1)
Estimated reading time: 1 minute
- This API provides the function to light up a specific LED Indicator, usually equipped in the front of the device to show the current device status to the user.
Note
- When requesting to change the LED indicator status with this API, you should take care not to return it to its original status when terminating your application.
Syntax
- http://<Base URL>/system
Authentication Level
- generic
Request
- params' Elements
- An object composed of the following pair(s).
name | type | multiplicity | default | description |
---|---|---|---|---|
mode | string | 1 | Functional meaning of the target LED.
|
|
status | string | ? | null | Turns on the LED Indicator.
|
- JSON Example
-
{ "method": "setLEDIndicatorStatus", "id": 53, "params": [{ "mode": "Demo", "status": "true" }], "version": "1.1" }
Response
- result's Elements
- Not necessary.
- JSON Example
-
{ "result": [], "id": 53 }
- Error Code
- The following error codes are important for this API. Refer to error code for other errors.
code | Explanation |
---|---|
7 | Cannot change the status of the LED for device-specific reasons. |
Last modified: 6 Feb 2019