# Get Multifunction Card Basic Information

This API endpoint retrieves the basic information of multifunction cards.

# Request Path

{CLTPlatform-ip}:8086/multiFunctionCard/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 - - multiFunctionCard/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 >> functionCardIndex Function card index within the network port (starts from 0) Yes int - - -

# Request Example

{
    "command": "multiFunctionCard/getInformation",
    "data": {
        "senderIndex": 0,
        "portIndex": 0,
        "functionCardIndex": 0
    }
}

# Response

Parameter Name Description Required Type Data Dictionary Restriction Example
command Command type Yes string - - multiFunctionCard/getInformation
code Status code Yes int - - -
message Message Yes string - - -
data Data Yes object - - -
data >> typeVersion Model and version information Yes string - - -
data >> boardTemperature Board temperature (°C) Yes float - - -
data >> boardHumidity Board humidity (%) Yes float - - -
data >> relayInfoList Array of relay information Yes array - - -
data >> relayInfoList >> relayName Relay name Yes string - J9~J12 -
data >> relayInfoList >> delayTime Relay open/close delay time (seconds), valid for J9~J12 Yes int - - -
data >> relayInfoList >> bOn Whether the relay is closed Yes boolean - - -
data >> probeInfoList Array of probe information Yes array - - -
data >> probeInfoList >> interfaceIndex Interface number (1~4) Yes int - - -
data >> probeInfoList >> probeIndex Probe index within the interface (starts from 1) Yes int - - -
data >> probeInfoList >> typeName Type name Yes string - Air Purity -
data >> probeInfoList >> data Data (temperature, humidity, smoke, etc.) Yes string - PM2.5:35(ug/m³)/PM10:50(ug/m³) -
data >> time Card time Yes object - - -
data >> time >> year Year Yes int - - -
data >> time >> month Month Yes int - - -
data >> time >> day Day Yes int - - -
data >> time >> hour Hour Yes int - - -
data >> time >> minute Minute Yes int - - -
data >> time >> second Second Yes int - - -
data >> time >> weekDay Weekday Yes int - - -

# Response Example

{
    "command": "multiFunctionCard/getInformation",
    "code": 0,
    "message": "",
    "data": {
        "typeVersion": "IM9 12.55(ARM: 12.55 FPGA: 12.55)",
        "boardTemperature": 25.5,
        "boardHumidity": 45.3,
        "relayInfoList": [
            {
                "relayName": "J9",
                "delayTime": 0,
                "bOn": false
            },
            {
                "relayName": "J10",
                "delayTime": 0,
                "bOn": true
            },
            {
                "relayName": "J11",
                "delayTime": 2,
                "bOn": false
            },
            {
                "relayName": "J12",
                "delayTime": 0,
                "bOn": true
            }
        ],
        "probeInfoList": [
            {
                "interfaceIndex": 1,
                "probeIndex": 1,
                "typeName": "Temperature",
                "data": "23.4°C"
            },
            {
                "interfaceIndex": 2,
                "probeIndex": 1,
                "typeName": "Humidity",
                "data": "52%"
            },
            {
                "interfaceIndex": 3,
                "probeIndex": 1,
                "typeName": "Smoke Detection",
                "data": "No Smoke"
            },
            {
                "interfaceIndex": 4,
                "probeIndex": 1,
                "typeName": "Air Purity",
                "data": "PM2.5:35(ug/m³)/PM10:50(ug/m³)"
            }
        ],
        "time": {
            "year": 2024,
            "month": 8,
            "day": 1,
            "hour": 12,
            "minute": 30,
            "second": 0,
            "weekDay": 4
        }
    }
}

# Detailed Description