Get FGate Drive List

  • Description

    This interface retrieves all connected devices of FGate.

  • Request Address

    URL:[Host Server]/api/v2/box/{boxId}/device

  • Address Parameter Description

    Field Type Description
    Host Server string See Explanation of terms
    boxId string Find it in Get FGate list interface: boxRegs->box->id

  • Method

    GET

  • Headers

    Field Type Description
    Authorization string "Bearer " + Access Token obtained from the login interface

  • Body

    NULL

  • Returned Fields
    Returned as a JSON array, attributes for a device are as follows:

    Field Type Description
    plcId int PLC ID, if multiple identical PLCs are connected with one FGate, the ID is not unique and cannot be used as a primary key
    plcName string PLC name
    alias string PLC alias
    type int 0: Serial type, 2: Network type
    advanced JSON Object Advanced parameters for PLC configuration, see details in the table below
    portNo int PLC number, 1: Serial port 1, 2: Serial port 2, 3: Serial port 3, above 4096 is Ethernet
    plcDongleFlag int Remote shutdown status, 0: Not supported, 1: Enabled, 2: Disabled, 3: Not configured, 4: Box is offline
    interface int Serial port parameters, interface type, 0: RS232, 1: RS485_2, 2: RS485_4, 85: Network (Serial port 1 supports RS232, RS485_2, and RS485_4, Serial port 2 supports only RS485_2, Serial port 3 supports only RS232)
    baudRate int Serial port parameters, baud rate
    dataBits int Serial port parameters, data bit
    stopBits int Serial port parameters, stop bit
    parityType int Serial port parameters, parity bit
    class int 0:0: Master device, 1: Slave device, 2: Master-slave device (currently not supported)
    ip string Network PLC parameters, IP address
    port int Network PLC parameters, port number
    enabledBroadcast boolean Whether to enable broadcast station number
    broadcasetStationNo int Broadcast station number
    slaveNo int Slave device number

    Advance object properties:

    Field Type Description
    plcResponseTimeout int Communication timeout parameter
    protocolTimeout1 int Protocol timeout parameter 1
    protocolTimeout2 int Protocol timeout parameter 2
    maxPacketsWordReg int Maximum number of registers per word group
    maxPacketsBitReg int Maximum number of registers per bit group
    assembleIntervalWordReg int Word register grouping interval
    assembleIntervalBitReg int Bit register grouping interval
    protocolInterval int Communication interval time (unit: s)
    byteOrder16 int Byte order of 16-bit integers 0: 21, 1: 12
    byteOrder32 int Byte order of 32-bit integers 0: 4321, 1: 3412, 2: 2143, 3: 1234
    byteOrderFloat int Byte order of 32-bit floating point numbers 0: 4321, 1: 3412, 2: 2143, 3: 1234
    retryType int Retry type, 0: Retry, 1: Disconnect
    alarmInfDispTms int Prompt message display time

  • Response Codes

    Code Description
    401 Access token expired
    404 Interface does not exist, please check the URL