Upload
others
View
8
Download
0
Embed Size (px)
Citation preview
WSW Spark Auto Test Script protocol
V3.3
Beijing Wellservice Technology
1 / 32
Content 一、Communication interface ................................................................................................................. 3
二、Interaction protocol ............................................................................................................................ 4
1. Autoatical device configuration, then return the number of cocnfigured devices
4
2. Connecting device ........................................................................................................................... 4
3. Disconnecting device...................................................................................................................... 4
4. Start logging....................................................................................................................................... 5
5. Stop logging ....................................................................................................................................... 5
6. Updating test plan ........................................................................................................................... 6
7. Start testing......................................................................................................................................... 7
8. Start testing,calling test plan ................................................................................................... 8
9. Stop testing......................................................................................................................................... 8
10. Power off ......................................................................................................................................... 9
11. Power on ......................................................................................................................................... 9
12. Forcing Attach.............................................................................................................................10
13. Forcing Detach............................................................................................................................10
14. Locking frequency band .........................................................................................................11
15. Unlocking frequency band ....................................................................................................11
16. Disable mobile data..................................................................................................................12
17. Enable mobile data ...................................................................................................................12
18. Getting Parameter value of DL/UL MAC throughput................................................13
19. Getting IMSI and IP of device ..............................................................................................13
20. 20. Setting Qualcomm subframe........................................................................................14
21. Exporting detailed decoded contents of L3 messages ............................................15
22. Exporting Parameters ..............................................................................................................16
23. Activating PDU............................................................................................................................17
24. Releasing PDU.............................................................................................................................17
25. Getting IP of PDU APN............................................................................................................18
26. Activating S-NSSAI ...................................................................................................................18
27. Sending AT command.............................................................................................................19
Beijing Wellservice Technology
2 / 32
28. Configuring 5G network mode of Hisilicon devices ..................................................20
29. Configuring APN........................................................................................................................21
30. Start UL packet testing ............................................................................................................22
31. Stop UL packet testing ............................................................................................................22
32. Configuring template of exported parameters............................................................23
33. Getting test event ......................................................................................................................25
34. Universal AT command interface....................................................................................25
35. Getting parameter instance value ......................................................................................26
36. Getting parameter value list .................................................................................................27
37. Connecting a specified device .............................................................................................28
38. Disconnecting a specified device .......................................................................................29
39. Configuring a specified device to start logging ..........................................................29
40. Configuring a specified device to stop logging...........................................................30
Appendix:NR5G parameters...........................................................................................................31
Beijing Wellservice Technology
3 / 32
一、Communication interface
1. 3rd-party software communicates Spark via TCP/IP,which is the IP of the PC that
Spark installed,the port number is 30999,user can use socket to interact with Spark.
2. 2. The interaction protocol use JSON ,UTF8 encoding. See the chapter "interaction
protocol" for the more detailed..
3. There is response message for each command you sent,every time you send a
command message,you need to wait for the response message and then you can
send the next command, otherwise the command may be missed.
4. Run SPark,if the auto test feature is included in the license, Spark will automatically
monitor for auto test.
5. It is suggest that you directly copy and paste the JSON commands which listed in
the protocol to your Socket tool for verification, before doing so,please note that
you must delete the remark part first.
6. If the requested JSON format is not correct, a string beginning with JSON error will
be the returned and show you the detailed description.
Beijing Wellservice Technology
4 / 32
二、Interaction protocol
1. Autoatical device configuration, then return the number of
cocnfigured devices
Req:
{
"CMD": "AutoCheck"
}
Res:
{
"CMD": "AutoCheck",
"Param": {
"State": 0, //0:success, other numbers represent error codes.
"Count": 2 //Device numbers
}
}
2. Connecting device
Req: This command is sent to all devices.
{
"CMD": "ConnectEQ"
}
Res:
{
"CMD": "ConnectEQ",
"Param": {
"State": 0 //0:success, other numbers represent error codes.
}
}
3. Disconnecting device
Req: This command is sent to all connected devices
{
"CMD": "DisConnectEQ"
Beijing Wellservice Technology
5 / 32
}
Res:
{
"CMD": "DisConnectEQ",
"Param": {
"State": 0 //0:success, other numbers represent error codes.
}
}
4. Start logging
Req: This command is sent to all connected devices
{
"CMD": "StartLog",
"Param": {
"LogPath": "D:\\Logfiles\\", //If you do not change the storage
directory, please input””
"LogName": "AutoTest2019-130106" // No suffix name, Chinese character
with UTF-8 encoding
}
}
Res:
{
"CMD": " StartLog",
"Param": {
"State": 0 //0:success, other numbers represent error codes.
}
}
5. Stop logging
Req: This command is sent to all connected devices
{
"CMD": "StopLog"
}
Res:
{
"CMD": "StopLog",
Beijing Wellservice Technology
6 / 32
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
6. Updating test plan
Req:
{
"CMD": "UpdateTask",
"EQIndex": 1, //Device ID,1 indicates the device in the first position, -1
indicates all the devices
"Param": {
"TestPlans": [
{
"TestTasks": [
{
"TaskName": "Bandwidth Test",
"TaskEnable": true,
"TaskType": "iperf",
"TestTimes": 10,
"TestInterval": 10,
"CyclePeriod": 180,
"TestContent": {
"ConnectionSetup": {
"ConnectionType": "app"
},
"Protocol": "UDP",//UDP:UDP protocol,TCP:TCP
protocol
"ProtocolVer": 2, //2: BWT protocol,work with
TSFPServer,Windows only;3:iperf2 protocol;4:iperf3 protocol
"TestType": "UL",//UL:Uplink,DL:Downlink
"Address": "10.11.12.13",// Server IP
"Port": 5001,//Server port
"TestTime": 60, //seconds
"UDPBandwidth": 10000, //Kbps
"UDPBufferSize": 1024, //KB
"UDPPacketSize": 1400, //Byte
"Thread": 1
}
}
]
}
Beijing Wellservice Technology
7 / 32
]
}
}
Res:
{
"CMD": "UpdateTask",
"EQIndex": 1, // Device ID,1 indicates the device in the first position, -1
indicates all the devices
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Remark:Input parameter table for ConnectionType
Network connection type ConnectionType
APP test app
Current network current
Virtual network card virtualnetwork
AT dial up atipcall
AT NDIS dial up ndis
PPP dial up createppp
7. Start testing
Req:
{
"CMD": "StartTest",
"EQIndex": 1 // Device ID,1 indicates the device in the first position, -1
indicates all the devices
}
Res:
{
"CMD": "StartTest",
"EQIndex": 1, // Device ID,1 indicates the device in the first position, -1
indicates all the devices
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
8 / 32
8. Start testing,calling test plan
Req:
{
"CMD": "StartTestByName",
"EQIndex": 1, // Device ID,1 indicates the device in the first position, -1
indicates all the devices
"Param": {
"TaskName": ["Ping", "Attach"] // Array, support multiple test plan test
}
}
Res:
{
"CMD": "StartTestByName",
"EQIndex": 1, // Device ID,1 indicates the device in the first position, -1
indicates all the devices
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
9. Stop testing
Req:
{
"CMD": "StopTest",
"EQIndex": 1 // Device ID,1 indicates the device in the first position, -1
indicates all the devices
}
Res:
{
"CMD": "StopTest",
"EQIndex": 1, // Device ID,1 indicates the device in the first position, -1
indicates all the devices
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
9 / 32
10. Power off
Req:
{
"CMD": "PowerOff",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "PowerOff",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
11. Power on
Req:
{
"CMD": "PowerOn",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "PowerOn",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
10 / 32
12. Forcing Attach
Req:
{
"CMD": "Attach",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"UEMode": "5G_SA" //”4G” or “5G_SA” or “5G_NSA”
}
}
Res:
{
"CMD": "Attach",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
13. Forcing Detach
Req:
{
"CMD": "Detach",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "Detach",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
11 / 32
14. Locking frequency band
Req:
{
"CMD": "LockBand",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"BandStr": "1,3,5", // The band numbers are separated by commas.for
example:1,3,5,indicates locking Band1,Band3 and Band5。
"NetType": 0 //only valid for Hisilicon device:0:"5G NSA", 8:"5G
SA", 3:"4G", 2:"3G", 1:"2G", 11:"5G SA + LTE"
}
}
Res:
{
"CMD": "LockBand",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
15. Unlocking frequency band
Req:
{
"CMD": "UnlockBand",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "UnlockBand",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
Beijing Wellservice Technology
12 / 32
}
16. Disable mobile data
Req:
{
"CMD": "TurnOffMobileData",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "TurnOffMobileData",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
17. Enable mobile data
Req:
{
"CMD": "TurnOnMobileData",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "TurnOnMobileData",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
13 / 32
18. Getting Parameter value of DL/UL MAC throughput
Req:
{
"CMD": "GetParamMAC",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "GetParamMAC",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0, //0:success, other numbers represent error codes
"MACDL": 2000000, //bps, instance value of DL MAC throughput
"MACUL": 1000000 //bps, instance value of UL MAC throughput
}
}
19. Getting IMSI and IP of device
Req:
{
"CMD": "GetParamIMSI",
"EQIndex": 1 // Device ID,1 indicates the device in the first position,only
valid for one device
}
Res:
{
"CMD": "GetParamIMSI",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0, //0:success, other numbers represent error codes
"IMSI": "460020315993651", // IMSI of device
"IP": "10.68.59.136" //IP of device
}
Beijing Wellservice Technology
14 / 32
}
Remark:Please run UE manager APP in the phone and then enable the service before
you send this command to get the IMSI and IP of the device
20. 20. Setting Qualcomm subframe
Req:
{
"CMD": "SetSubFrame",
"Param": {
"QualcommEnable": true, // true: enable subframe feature; false: disable
subframe feature
"SubFrameSet":{ //Detailed setting of 5G subframe
"ItemListNR5G": [
{
"Code": 5070, //CQI/RI Info
"Checked": true //Message option:true:collect ;false:not
collect
}, {
"Code": 5080, //PDSCH Info
"Checked": true
}, {
"Code": 5081, //PUSCH Info
"Checked": true
}, {
"Code": 5090, //DL Grant Info
"Checked": true
}, {
"Code": 5091, //UL Grant Info
"Checked": true
}
],
"ItemListLTE": [ // Detailed setting of LTE subframe
{
"Code": 180, //LTE PDSCH Info
"Checked": true
}, {
"Code": 200, //LTE PUSCH Info
"Checked": true
}, {
"Code": 220, //LTE PUCCH Info
"Checked": true
}, {
"Code": 280, //LTE UL Grant Info
Beijing Wellservice Technology
15 / 32
"Checked": true
}, {
"Code": 300, //LTE DL Grant Info
"Checked": true
}, {
"Code": 560, //LTE UL MAC Info
"Checked": true
}, {
"Code": 580, //LTE DL MAC Info
"Checked": true
}, {
"Code": 600, //LTE UL RLC Info
"Checked": true
}, {
"Code": 620, //LTE DL RLC Info
"Checked": true
}, {
"Code": 680, //LTE UL PDCP Info
"Checked": true
}, {
"Code": 700, //LTE DL PDCP Info
"Checked": true
}
]
}
}
}
Res:
{
"CMD": "SetSubFrame",
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
21. Exporting detailed decoded contents of L3 messages
Req:
{
"CMD": "ExportMessageDetail",
"Param": {
Beijing Wellservice Technology
16 / 32
"ExportFileName": "C:\\e.xml", // input the full path of the exported
file; the field empty indicates the file will be exported to the Spark installation
directory\Data\Export
"Logfile": "C:\\t1.saf" //input the full path of the logfile to be
exported
}
}
Res:
{
"CMD": "ExportMessageDetail",
"Param": {
"State": 0 //0:success;-1: current logfile is occupied;-2:target xml fileis
occupied
}
}
Xml file format:
<MessageDetails>
<OneMessage> … </OneMessage>
<OneMessage> … </OneMessage>
…
</MessageDetails>
22. Exporting Parameters
Req:
{
"CMD": "ExportLogfile",
"Param": {
"TemplateName": "test", //Input the template file name
"ExportFileName": "C:\\e.csv", // input the full path of the exported
file; the field empty indicates the file will be exported to the Spark installation
directory\Data\Export
"Logfile": "C:\\t1.saf" // input the full path of the logfile to
be exported
}
}
Res:
{
"CMD": "ExportLogfile",
"Param": {
"State": 0 //0:success;-1:Template is not exist;-2:Template
Beijing Wellservice Technology
17 / 32
configuration issue
}
}
23. Activating PDU
Req://Add SSC_mode and S_NSSAI as input parameters to V2.6
{
"CMD": "SetupPDU",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"ID": 1,
"Type": "IPV4V6",
"APN": "wap2.xxx.com",
"SSC_mode": 0, //0:SSC mode1,1:SSC mode2
"S_NSSAI": "1.123456;2F.654321" //5GS fragment information,please note
that The data in the string is 16 hexadecimal, and the range of the character value
is:0-9,A-F,a-f
}
}
Res:
{
"CMD": "SetupPDU",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
24. Releasing PDU
Req:
{
"CMD": "ReleasePDU",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"ID": 1
}
Beijing Wellservice Technology
18 / 32
}
Res:
{
"CMD": "ReleasePDU",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
25. Getting IP of PDU APN
Req:
{
"CMD": "GetPDUInfo",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"APN": "wap2.xxx.com"
}
}
Res:
{
"CMD": "GetPDUInfo",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0, //0:success, other numbers represent error codes
"APN": "wap2.xxx.com",
"IP": "1.1.1.1"
}
}
26. Activating S-NSSAI
Req:
{
Beijing Wellservice Technology
19 / 32
"CMD": "SetupS_NSSAI",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"ID": 1,
"Type": "IPV4V6",
"APN": "wap2.xxx.com",
"SSC_mode": 0, //0:SSC mode1,1:SSC mode2
"S_NSSAI": "1.123456;2F.654321" //5GS fragment information,please note
that The data in the string is 16 hexadecimal, and the range of the character value
is:0-9,A-F,a-f
}
}
Res:
{
"CMD": "SetupS_NSSAI",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
// Remark:There are 5 combinations for S_NSSAI sst and sd:
1、"sst":"sst" if only slice/service type (SST) is present
Input parameter:1
2、"sst;mapped_sst": "sst;mapped_sst" if SST and mapped configured SST are present
Input parameter:1;2F
3、"sst.sd":"sst.sd" if SST and slice differentiator (SD) are present
Input parameter:1.123456
4、"sst.sd;mapped_sst":"sst.sd;mapped_sst" if SST, SD and mapped configured SST
are present
Input parameter:1.123456;2F
5、"sst.sd;mapped_sst.mapped_sd":"sst.sd;mapped_sst.mapped_sd" if SST, SD, mapped
configured SST and mapped configured SD are present
Input parameter:1.123456;2F.654321
27. Sending AT command
Req:
{
"CMD": "SendAT",
Beijing Wellservice Technology
20 / 32
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"Command": "AT", //Requested AT command
"Timeout": 5000 //time out (ms)
}
}
Res:
{
"CMD": "SendAT",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,only
valid for one device
"Param": {
"State": 0 //0:success; -1:open AT port failure; -2:Error; -3:tome
out
"Command": "AT", //Requested AT command
"Back": "OK" //returned result of AT command
}
}
28. Configuring 5G network mode of Hisilicon devices
Req:
{
"CMD": "Config5GDeployment",
"EQIndex": 1, // Device ID,1 indicates the device in the first position,
Comma segmentation between numbers
"Param": {
"NetType": 0 //0:"Auto", 8:"NSA mode", 20:" SA+NSA mode"
}
}
Res:
{
"CMD": "Config5GDeployment",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
21 / 32
Cause code list:
Cause code Description Remark
0 Success
-1 Failure
Restrictions:
1、Only valid for Mate 20X, Mate 30, Mate 30 PRO,UE SW version should update
to SP7or later version;
2、Please run UE manager APP in phone and keep the phone in the bright screen
state before send this command;
3、Once executed,the phone will change the network type immediately, no need
to restart
29. Configuring APN
Req:
{
"CMD": "ConfigureAPN",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"APN":"wap2.xxx.com", // APN Name
"MCC":"460", // MCC
"MNC":"02" // MNC
}
}
Res:
{
"CMD": "ConfigureAPN",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers .
"Param": {
"State": 0 //0:success, other numbers represent error
codes
}
}
Cause code list:
Cause code Description Remark
0 Success
-1 Failure
Beijing Wellservice Technology
22 / 32
30. Start UL packet testing
Req:
{
"CMD": "StartULtraffic",
"EQIndex": 1, //Device ID({-1,1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers; -1 indicates all the devices
"Param": {
"Protocol": "UDP", // default value: UDP
"Address": "10.57.163.34", //Server address
"Port": 5001, //Server port
"TestTime": 120, //test time
"Bandwidth": 1000, //Kbps.
"BufferSize": 1024, //KB
"PacketSize": 1400 //Byte
}
}
Res:
{
"CMD": "StartULtraffic",
"EQIndex": 1, // Device ID({-1,1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers; -1 indicates all the devices
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Cause code list:
Cause code Description Remark
0 Success
-1 Failure
31. Stop UL packet testing
Req:
{
"CMD": "StopULtraffic",
"EQIndex": 1 // Device ID({-1,1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers; -1 indicates all the devices
Beijing Wellservice Technology
23 / 32
}
Res:
{
"CMD": "StopULtraffic",
"EQIndex": 1, // Device ID({-1,1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers; -1 indicates all the devices
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Cause code list:
Cause code Description Remark
0 Success
-1 Failure
32. Configuring template of exported parameters
Generally,the default template name is set to test
Req:
{
"CMD": "Config5GNRmeasurementAndEvent",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers .
"Param": {
"IEList": ["event", "Cell ID"….] //event: export all the events;
Message: export all the L3 messages; parameter name must be correct, it
is suggest that copy from the Appendix NR5G parameter list,each field is
separated by a comma.
}
}
Res:
{
"CMD": "Config5GNRmeasurementAndEvent",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first position,
Comma segmentation between numbers.
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
24 / 32
Cause code list:
Cause code Description Remark
0 Success
-1 Failure
Beijing Wellservice Technology
25 / 32
33. Getting test event
Remark:This interface only supports to get the test events of the connected device,
By calling the interface regularly, you can get incremental events after you send the real
time LastEventIndex during the test.
Req:
{
"CMD": "GetEvents",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"LastEventIndex": 0 //Getting incremental event , when input 0, then
the return result will be index1 event,index2 event, and so on
}
}
Res:
{
"CMD": "GetEvents",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"State": 0 //0:success; -1: Device is not available;
other numbers represent error codes
"LastEventIndex": 1, //The value of the LastEventIndex which is
used for next request
"EventCount": 1,
"EventList": [
{
"Index": 1, //Event index, start from 1
"Time": 1500739860933013, //The microseconds passed after
January 1, 1970. Int64
"Name": "Attach Success",
"Detail": "Delay: 3ms"
}
]
}
}
34. Universal AT command interface
Req:
Beijing Wellservice Technology
26 / 32
{
"CMD": "SendAT",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"Command": "AT", //Specific AT command, For example:
AT+CFUN=0
"Timeout": 5000 // Response timeout , unit: ms
}
}
Res:
{
"CMD": "SendAT",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"State": 0 //0:success, other numbers represent error
codes
"Command": "AT", //AT command requested before
"Back": "OK" // Return result
}
}
Cause code list:
Cause code Description Remark
0 Success
-1 or else Failure
35. Getting parameter instance value
Req:
{
"CMD": "GetParamValue",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": [ //Parameter name(Array),the name is case sensitive,
space and other characters, and the input parameter name must be consistent with
those in the Appendix nr5g parameter list
"NR SSB RSRP[dBm]",
"NR SSB SINR[dB]",
"NR PCI"
]
Beijing Wellservice Technology
27 / 32
}
Res.:
{
"CMD": "GetParamValue",
"EQIndex": 1, //Device ID({1~n}), 1 indicates the device in the
first position,Comma segmentation between numbers
"Param": {
"State": 0, //0:Success; -1: Non-test state; -2: parameter not
support to access,null value
"Values": [ // Parameter value (array), value is string type.
"-88.68",
"10.61",
"295"
]
}
}
Cause code list:
Cause code Description Remark
0 Success Return query results
-1 Failure-non-test state
-2 Failure-parameter not
support to access
36. Getting parameter value list
Req :
{
"CMD": "GetParamValueList",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"ParamName": "NR PDSCH DMRS RSSI[dBm]", // Parameter name(Array),the name
is case sensitive, space and other characters, and the input parameter name must be
consistent with those in the Appendix nr5g parameter list
"FilterParamName": "NR PDSCH DMRS PortIndex", //Name of condition
parameter, and the input parameter name must be consistent with those in the
Beijing Wellservice Technology
28 / 32
Appendix nr5g parameter list
"FilterParamValue": 0 //Value of parameter
}
}
Res:
{
"CMD": "GetParamValueList",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the
first position,Comma segmentation between numbers
"Param": {
"State": 0, //0:Success; -1: Non-test state; -2: parameter not
support to access,null value,
"Values": [ // Parameter value (array), value is string type
"-88.68",
"-86.61",
"-85.66"
]
}
}
Cause code list:
Cause code Description Remark
0 Success Return query results
-1 Failure-non-test state
-2 Failure-parameter not
support to access
37. Connecting a specified device
Req:
{
"CMD": "ConnectOneEQ",
"EQIndex": 1 // Device ID({1~n}), 1 indicates the device in the first
position;
}
Res:
{
"CMD": "ConnectOneEQ",
Beijing Wellservice Technology
29 / 32
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position;
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
38. Disconnecting a specified device
Req:
{
"CMD": "DisConnectOneEQ",
"EQIndex": 1 // Device ID({1~n}), 1 indicates the device in the first
position;
}
Res:
{
"CMD": "DisConnectOneEQ",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position;
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
39. Configuring a specified device to start logging
Req:
{
"CMD": "StartOneLog",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position ,Comma segmentation between numbers
"Param": {
"LogPath": "D:\\Logfiles\\", // Input the full path of the exported
file,if you do not change the storage directory, please input””
"LogName": "AutoTest2019-130106" // No suffix name, Chinese character
with UTF-8 encoding
}
}
Beijing Wellservice Technology
30 / 32
Res:
{
"CMD": "StartOneLog",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
40. Configuring a specified device to stop logging
Req:This command is sent to all connected devices
{
"CMD": "StopOneLog",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
}
Res:
{
"CMD": "StopOneLog",
"EQIndex": 1, // Device ID({1~n}), 1 indicates the device in the first
position,Comma segmentation between numbers
"Param": {
"State": 0 //0:success, other numbers represent error codes
}
}
Beijing Wellservice Technology
31 / 32
Appendix:NR5G parameters
Index Parameter name
1 NR SSB ARFCN DL
2 NR PCI
3 NR SSB RSRP[dBm]
4 NR SSB SINR[dB]
5 NR SSB RSRQ[dB]
6 NR SSB RSSI[dBm]
7 NR SDAP Thr. DL [Mbps]
8 NR PDCP Thr. DL [Mbps]
9 NR RLC Thr. DL [Mbps]
10 NR MAC Thr. DL [Mbps]
11 NR PHY Thr. DL [Mbps]
12 NR SDAP Thr. UL [Mbps]
13 NR PDCP Thr. UL [Mbps]
14 NR RLC Thr. UL [Mbps]
15 NR MAC Thr. UL [Mbps]
16 NR PHY Thr. UL [Mbps]
17 NR PDSCH TotalRBCount
18 NR PDSCH SlotCount
19 NR PDSCH RBCountPerSlot
20 NR PUSCH TotalRBCount
21 NR PUSCH SlotCount
22 NR PUSCH RBCountPerSlot
23 NR PDCCH DL Grant Count
24 NR PDCCH UL Grant Count
25 NR PDSCH BLER[%]
26 NR PDSCH iBLER[%]
27 NR PDSCH Resi.BLER[%]
28 NR PUSCH BLER[%]
29 NR PUSCH iBLER[%]
30 NR PUSCH Resi.BLER[%]
31 NR PDCCH BLER[%]
32 NR Rank Avg. DL
33 NR Rank Avg. UL
34 NR MCS Avg. DL
35 NR MCS Avg. UL
36 NR Modulation Most DL
37 NR Modulation Most UL
38 NR CQI Avg.
39 NR MCC
Beijing Wellservice Technology
32 / 32
40 NR MNC
41 NR Band
42 NR BandWidth DL
43 NR WorkMode DL
44 NR Cell ID
45 NR gNodeB ID
46 NR Sector ID
47 NR SubCarrierSpace
48 NR SS GSCN
49 NR SSB Freq. DL(MHz)
50 NR PointA ARFCN DL
51 NR PointA Freq. DL(MHz)
52 NR Center ARFCN DL
53 NR Center Freq. DL(MHz)
54 NR PDSCH DMRS PortIndex
55 NR PDSCH DMRS LayerIndex
56 NR PDSCH DMRS RSSI[dBm]
57 NR PDSCH DMRS SINR[dB]
58 NR PUCCH DMRS PortIndex
59 NR PUCCH DMRS LayerIndex
60 NR PUCCH DMRS RSSI[dBm]
61 NR PUCCH DMRS SINR[dB]