Detect Smart Module Status Information

This API endpoint detects the status information of smart modules.

Request Path

{CLTPlatform-ip}:8086/module/detectAllDevice

• Replace {CLTPlatform-ip} with the corresponding IP address.
• The request port is 8086.

Protocol

HTTP

Method

POST

Request Parameters

• Set the Content-Type of the request body to application/json.

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	string	-	-	module/detectAllDevice
data	Data	Yes	object	-	-	-

Request Example

{
    "command": "module/detectAllDevice",
    "data": {}
}

Response

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	string	-	-	module/detectAllDevice
code	Status code	Yes	int	-	-	-
message	Message	Yes	string	-	-	-
data	Data	Yes	object	-	-	-
data >> deviceList	List of detected devices	Yes	array	-	-	-
data >> deviceList >> senderIndex	Sender index (starts from 0)	Yes	int	-	-	-
data >> deviceList >> portIndex	Network port index (starts from 0)	Yes	int	-	-	-
data >> deviceList >> receiverIndex	Receiver card index (starts from 0)	Yes	int	-	-	-
data >> deviceList >> serialPortIndex	Serial port index (starts from 0)	Yes	int	-	-	-
data >> deviceList >> inSerialPortIndex	Index within the serial port (starts from 0)	Yes	int	-	-	-
data >> deviceList >> bValid	Whether the device is valid	Yes	boolean	-	-	-

Response Example

{
    "command": "module/detectAllDevice",
    "code": 0,
    "message": "",
    "data": {
        "deviceList": [{
            "senderIndex": 0,
            "portIndex": 0,
            "receiverIndex": 0,
            "serialPortIndex": 0,
            "inSerialPortIndex": 0,
            "bValid": false
        }]
    }
}

Detailed Description