CLTPlatform SDK User Manual

# Read Back Mapping from Receiver

This API can be used to read back the mapping data from a receiver.

# API Path

{CLTPlatform-ip}:8086/receiver/readReceiverMappingV2

  • 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] receiver/readReceiverMappingV2
data Data Yes [object]
data>>senderIndex Sender index (starts from 0) Yes [int] 0
data>>portIndex Network port index (starts from 0) Yes [int] 0

# Request Example

{
    "command": "receiver/readReceiverMappingV2",
    "data": {
        "senderIndex": 0,
        "portIndex": 0
    }
}

# Response

Parameter Name Description Required Type Data Dictionary Restriction Example
command Command type Yes [string] receiver/readReceiverMappingV2
code Status code Yes [int] 20000
message Message Yes [string] Common_Success
data Data Yes [object]
data>>receiverMapping Receiver mapping Yes [object]
data>>receiverMapping>>senderArray Sender array Yes [array]
data>>receiverMapping>>senderArray>>item[0] Yes [object]
data>>receiverMapping>>senderArray>>item[0]>>senderIndex Sender index Yes [int]
data>>receiverMapping>>senderArray>>item[0]>>portArray Network port array Yes [array]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0] Yes [object]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>portIndex Network port index Yes [int]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>isBackupPort Whether is backup network port Yes [boolean]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>srcPort Main network port, which is valid when isBackupPort is true Yes [object]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>srcPort>>senderIndex Sender index Yes [int]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>srcPort>>portIndex Network port index Yes [int]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>area Network port control area Yes [object]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>area>>x x Yes [int] 0
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>area>>y y Yes [int] 0
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>area>>width Width Yes [int] 128
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>area>>height Height Yes [int] 128
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray Receiver array，which can be empty when isBackupPort is true Yes [array]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0] Yes [object]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0]>>receiverIndex Receiver card index Yes [int]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0]>>area Yes [object]
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0]>>area>>x x Yes [int] 0
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0]>>area>>y y Yes [int] 0
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0]>>area>>width Width Yes [int] 128
data>>receiverMapping>>senderArray>>item[0]>>portArray>>item[0]>>receiverArray>>item[0]>>area>>height Height Yes [int] 128

# Response Example

{
    "command": "receiver/readReceiverMappingV2",
    "code": 20000,
    "message": "Common_Success",
    "data": {
        "receiverMapping": {
            "senderArray": [{
                "senderIndex": 0,
                "portArray": [{
                    "portIndex": 0,
                    "isBackupPort": false,
                    "srcPort": {
                        "senderIndex": 0,
                        "portIndex": 0
                    },
                    "area": {
                        "x": 0,
                        "y": 0,
                        "width": 128,
                        "height": 128
                    },
                    "receiverArray": [{
                        "receiverIndex": 0,
                        "area": {
                            "x": 0,
                            "y": 0,
                            "width": 128,
                            "height": 128
                        }
                    }]
                }]
            }]
        }
    }
}

# Detailed Description

← Receiver Highlight →