播放盒-EN
  1. Receiving card-related
播放盒-EN
  • API access guide
  • Common Error Codes
  • FAQ
  • User-related
    • Log in to devices
      POST
    • Log out of the device
      DELETE
    • Change user information
      PUT
  • System control-related
    • Screenshot
      GET
    • Restart the device immediately
      POST
    • Obtain device restart schedules
      GET
    • Schedule device restarts
      POST
    • Set time
      POST
    • Install apps
      PUT
    • Obtain time
      GET
    • Factory reset
      PUT
    • Obtain terminal information
      GET
    • Obtain volume
      GET
    • Set volume
      POST
    • Upgrade the device
      PUT
    • Check local upgrade status
      GET
  • Screen control-related
    • Receiving card-related
      • Obtain receiving card connection information
        GET
      • Obtain receiving card monitoring information
        POST
      • Obtain basic information of the receiving card
        POST
      • Configure the screen via receiving card configuration (send .rcfgx file)
        POST
      • Configure the screen via receiving card configuration (send .scr file)
        POST
      • Upgrade the receiving card
        PUT
      • Obtain the receiving card upgrade progress
        GET
    • Send Card-related
      • Obtain the basic Information of the sending card
    • Obtain screen brightness
      GET
    • Set screen brightness
      POST
    • Obtain screen status
      GET
    • Set screen status
      POST
    • Obtain screen-on/off schedules
      GET
    • Set screen-on/off schedules
      POST
    • Set brightness adjustment schedules
      POST
    • Obtain brightness adjustment schedules
      GET
  • General capabilities
    • Upload files
    • Download files
  • Serial port control
    • Activate RS-485 serial communication
    • Check RS-485 serial port status
  • Board relays
    • Obtain relay information
    • Set relay information
  1. Receiving card-related

Configure the screen via receiving card configuration (send .rcfgx file)

Developing
POST
/terminal/core/v1/receivecard/config
Last modified:2024-12-13 07:41:46
This interface is used for configuring the screen via receiving card configuration.
Before calling this interface, please upload the receiving card configuration file (.rcfgx) to the following path: /sdcard/nova/viplex_terminal/receive_card/recover_local/

Request

Header Params
Authorization
string 
optional
Default:
1724333189506EO5Zqpduu4+azwYYXMJJhg==
Body Params application/json
resolveType
integer 
required
1: Do not use the rule file (default)
rcParamBackUpList
array [object {4}] 
required
Receiving card parameter file list
filePath
string 
required
Receiving card parameter file path
portIndex
integer 
required
Ethernet port number
Output port number
Starts from 0. 255 means to execute all.
connectedIndex
integer 
required
Receiving card number
Number of the receiving card connected to the output port
Starts from 0. 65535 means to execute all.
md5
string 
required
MD5 value of the receiving card parameter file
solidityRequired
boolean 
optional
Whether to save to hardware
Defaults to true.
Example
{
  "resolveType": 1,
  "rcParamBackUpList": [
    {
      "filePath": "/sdcard/nova/viplex_terminal/receive_card/recover/recover_local/1111.rcfgx",
      "portIndex": 1,
      "connectedIndex": 0,
      "md5": "a5e8bd82fe9aafd696a7ea5f62aa9ca9"
    },
    {
      "filePath": "/sdcard/nova/viplex_terminal/receive_card/recover/recover_local/1111.rcfgx",
      "portIndex": 0,
      "connectedIndex": 0,
      "md5": "5fdc7ae4752309e9903cd7d9ba9585f1"
    }
  ],
  "solidityRequired": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://192.168.0.10:16674/terminal/core/v1/receivecard/config' \
--header 'Authorization: 1724333189506EO5Zqpduu4+azwYYXMJJhg==' \
--header 'Content-Type: application/json' \
--data-raw '{
  "resolveType": 1,
  "rcParamBackUpList": [
    {
      "filePath": "/sdcard/nova/viplex_terminal/receive_card/recover/recover_local/1111.rcfgx",
      "portIndex": 1,
      "connectedIndex": 0,
      "md5": "a5e8bd82fe9aafd696a7ea5f62aa9ca9"
    },
    {
      "filePath": "/sdcard/nova/viplex_terminal/receive_card/recover/recover_local/1111.rcfgx",
      "portIndex": 0,
      "connectedIndex": 0,
      "md5": "5fdc7ae4752309e9903cd7d9ba9585f1"
    }
  ],
  "solidityRequired": true
}'

Responses

🟢200成功
application/json
Body
code
integer 
required
Return code
0x00: Successful
0x01: The Taurus and receiving card are being upgraded.
0x02: The file address is empty/the set in the sent parameters is empty.
0x03: resolveType type is not supported.
0x11: The screen is currently being configured/recovered.
0x13: The file does not exist.
0x18: File verification failed.
0x24: The current device type does not support this interface./There are unsupported receiving cards and the current operation is canceled.
message
string 
required
Return information
Example
{
  "code": 0,
  "message": ""
}
Previous
Obtain basic information of the receiving card
Next
Configure the screen via receiving card configuration (send .scr file)
Built with