Get Smart Module Status Information

This API endpoint retrieves the status information of smart modules.

Request Path

{CLTPlatform-ip}:8086/module/getInformation

• 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/getInformation
data	Data	Yes	object	-	-	-
data >> senderIndex	Sender index (starts from 0)	Yes	int	-	-	-
data >> portIndex	Network port index (starts from 0)	Yes	int	-	-	-
data >> receiverIndex	Receiver card index (starts from 0)	Yes	int	-	-	-

Request Example

{
    "command": "module/getInformation",
    "data": {
        "senderIndex": 0,
        "portIndex": 0,
        "receiverIndex": 0
    }
}

Response

Parameter Name	Description	Required	Type	Data Dictionary	Restriction	Example
command	Command type	Yes	string	-	-	module/getInformation
code	Status code	Yes	int	-	-	-
message	Message	Yes	string	-	-	-
data	Data	Yes	object	-	-	-
data >> moduleInfoList	Array of module information	Yes	array	-	-	-
data >> moduleInfoList >> serialPortIndex	Serial port index (starts from 0)	Yes	int	-	-	-
data >> moduleInfoList >> inSerialPortIndex	Module index within the serial port (starts from 0)	Yes	int	-	-	-
data >> moduleInfoList >> monitorInfo	Monitoring information	Yes	object	-	-	-
data >> moduleInfoList >> monitorInfo >> bValid	Whether the data is valid	Yes	boolean	-	-	-
data >> moduleInfoList >> monitorInfo >> temperature	Temperature (°C), 142.9375 indicates unsupported	Yes	float	-	-	-
data >> moduleInfoList >> monitorInfo >> humidity	Humidity (%), 127.99609375 indicates unsupported	Yes	float	-	-	-
data >> moduleInfoList >> monitorInfo >> voltage	Voltage (V), 127.99609375 indicates unsupported	Yes	float	-	-	-
data >> moduleInfoList >> monitorInfo >> workTime	Total working time (unit is 10 minutes)	Yes	int	-	-	-
data >> moduleInfoList >> monitorInfo >> version	Program version number	Yes	string	-	-	-
data >> moduleInfoList >> monitorInfo >> bFlashExist	Whether flash exists	Yes	boolean	-	-	-
data >> moduleInfoList >> monitorInfo >> bCrcSuccess	Whether CRC check passes	Yes	boolean	-	-	-
data >> moduleInfoList >> stateInfo	State information	Yes	object	-	-	-
data >> moduleInfoList >> stateInfo >> bValid	Whether the data is valid	Yes	boolean	-	-	-
data >> moduleInfoList >> stateInfo >> area	Control area	Yes	object	-	-	-
data >> moduleInfoList >> stateInfo >> area >> top	Top Y coordinate	Yes	int	-	-	-
data >> moduleInfoList >> stateInfo >> area >> left	Left X coordinate	Yes	int	-	-	-
data >> moduleInfoList >> stateInfo >> area >> right	Right X coordinate	Yes	int	-	-	-
data >> moduleInfoList >> stateInfo >> area >> bottom	Bottom Y coordinate	Yes	int	-	-	-

Response Example

{
    "command": "module/getInformation",
    "code": 0,
    "message": "",
    "data": {
        "moduleInfoList": [
            {
                "serialPortIndex": 0,
                "inSerialPortIndex": 0,
                "monitorInfo": {
                    "bValid": true,
                    "temperature": 25.5,
                    "humidity": 45.3,
                    "voltage": 5.0,
                    "workTime": 1000,
                    "version": "1.0.0",
                    "bFlashExist": true,
                    "bCrcSuccess": true
                },
                "stateInfo": {
                    "bValid": true,
                    "area": {
                        "top": 0,
                        "left": 0,
                        "right": 1920,
                        "bottom": 1080
                    }
                }
            }
        ]
    }
}

Detailed Description