Get Server Drive List
Description
Pulls the list of drivers supported by FGate from the server.
Request Address
URL:
[Host Server]/api/device/spec/{boxType}Address Parameter Description
Field Type Description Host Server string See Explanation of terms boxType int Type: 0 for Standard, 1 for Mini, 2 for Lite, 3 for VPN Method
GETHeaders
Field Type Description Authorization string "Bearer " + Access Token obtained from the login interface Body
NULLResponse Fields
Field Type Description id int Device ID name string PLC Name defaultStationNo int Default station No minStationNo int Minimum station No maxStationNo int Maximum station No class int Device type: 0 for Other, 1 for Master, 2 for Slave comPortParams json object Serial port default configuration, details in the table below ethParams json object Ethernet default configuration, details in the table below byteOrders json object Byte order information, details in the table below supportedPlcs string array Supported PLC types regs JSON Array Supported register list, details in the table below broadcastNo int Broadcast station No manufacturer string PLC Manufacturer connType int 0:Serial port, 1:Ethernet comPortParams Object Properties:
Field Type Description baudRate int Serial port baud rate dataBits int Serial port data bit stopBits int Serial port stop bit parity int Serial port parity bit workingMode int Connection type: 1:RS232, 2:RS485_4, 3:RS485_2 plcResponseTimeout int Communication timeout protocolTimeout1 int Protocol timeout parameter 1 protocolTimeout2 int Protocol timeout parameter 2 maxPacketsWordReg int Maximum number of word registers in a packet maxPacketsBitReg int Maximum number of bit registers in a packet assembleIntervalWordReg int Interval to packet word register assembleIntervalBitReg int Interval to packet bit register protocolInterval int Communication interval ethParams Object Properties:
Field Type Description ip string Network parameter: IP address port int Communication port plcResponseTimeout int Communication timeout protocolTimeout1 int Protocol timeout parameter 1 protocolTimeout2 int Protocol timeout parameter 2 maxPacketsWordReg int Maximum number of word registers in a packet maxPacketsBitReg int Maximum number of bit registers in a packet assembleIntervalWordReg int Interval to packet word register assembleIntervalBitReg int Interval to packet bit register protocolInterval int Communication interval regs Array Single Object Properties:
Field Type Description id int Register ID, not unique for the same device, needs to be combined with Iowidth to determine a register name string Register name ioWidth int Register bit width: 0:Bit, 1:Byte, 2:Word, 3:DWord, 4:QWord mainAddrWitdh int Main address addressing mode: 0:Bit, 1:Byte, 2:Word, 3:DWord, 4:QWord minMainAddr int Minimum main address value maxMainAddr int Maximum main address value mainAddrType int Main address representation type: 0:None, 8:Octal, 10:Decimal, 16:Hexadecimal subAddrType int Subaddress representation type: 0:None, 8:Octal, 10:Decimal, 16:Hexadecimal subAddrLen int Subaddress usage: if subAddrLen is 3, then the range is from 0 to 7 ([0, 2^subAddrLen -1]) subIndexType int DB block address representation type (commonly used by Siemens): 0:None, 8:Octal, 10:Decimal, 16:Hexadecimal minSubIndex int Minimum DB block address maxSubIndex int Maximum DB block address byteOrders Object Properties:
Field Type Description u16 int 0:21,1:12 u32 int 0:4321,1:3412,2:2143,3:1234 float int 0:4321,1:3412,2:2143,3:1234 Return Codes
Code Description 401 Access token expired 404 Interface does not exist, please check the URL