RUI3 (RAK Unified Interface 3) - RAK4631
bg77::qicfg

Public Member Functions

String get (String)
 
String set (String, int)
 
String set (String, int, int)
 
String set (String, int, int, int, int)
 

Member Function Documentation

◆ get()

String get ( String  )
Description
This api configures optional parameters.
Syntax
bg77.qicfg.get(para)
Parameters
paraString String type.
  • "transpktsize"
  • "transwaittm"
  • "dataformat"
  • "viewmode"
  • "recvind"
  • "sack"
  • "tcp/keepalive"
  • "tcp/retranscfg"
Returns
String response

◆ set() [1/3]

String set ( String  ,
int   
)
Description
This api configures optional parameters.
Syntax
bg77.qicfg.set(para,conf)
Parameters
paraString String type.
  • "transpktsize"
  • "transwaittm"
  • "viewmode"
  • "recvind"
  • "sack"
  • "tcp/keepalive"
confint
  • "transpktsize" Integer type. Maximum length of the data packet to be sent. Range: 1–1460. Default value: 1024. Unit: byte.
  • "transwaittm" Integer type. In transparent transmission mode, if the length of data received from the port is less than the specified value of <transpkt_size>, after exceeding the time specified by <transwaittm>, the data will be sent directly. Range: 0–20. Default value: 2. Unit: 100 ms.
  • "viewmode" Integer type. Output format of received data.
    • 0 Output format of received data: data header.
    • 1 Output format of received data: data header,data.
  • "recvind" Integer type. URC format.
    • 0 URC format without data length. URC format is +QIURC: "recv",<connectID>.
    • 1 URC format with data length. URC format is +QIURC: "recv",<connectID>,<data_len>.
  • "sack" Integer type. Whether to enable SACK option in TCP header.
    • 0 Disable
    • 1 Enable
  • "tcp/keepalive" Integer type. Whether to enable TCP keepalive feature. When it is 0, <idle_time>, <interval_time> and <probe_cnt> should be ignored.
    • 0 Disable
    • 1 Enable
Returns
String response

◆ set() [2/3]

String set ( String  ,
int  ,
int   
)
Description
This api configures optional parameters.
Syntax
bg77.qicfg.set(para,conf1,conf2)
Parameters
paraString String type.
  • "dataformat"
  • "tcp/retranscfg"
conf1int
  • "dataformat" Integer type. Format of the data to be sent.
    • 0 Text mode
    • 1 Hex mode
  • "tcp/retranscfg" Integer type. Maximum number of TCP retransmissions. Range: 3–20. Default value: 12.
conf2int
  • "dataformat" Integer type. Format of the data to be received.
    • 0 Text mode
    • 1 Hex mode
  • "tcp/retranscfg" Integer type. Maximum interval between TCP retransmissions. Range: 5–1000. Default value: 600. Unit: 100 ms.
Returns
String response

◆ set() [3/3]

String set ( String  ,
int  ,
int  ,
int  ,
int   
)
Description
This api configures optional parameters.
Syntax
bg77.qicfg.set(para,keepalive,idle_time,interval_time,probe_cnt)
Parameters
paraString String type.
  • "tcp/keepalive"
keepaliveint
  • "tcp/keepalive" Integer type. Whether to enable TCP keepalive feature. When it is 0, <idle_time>, <interval_time> and <probe_cnt> should be ignored.
    • 0 Disable
    • 1 Enable
idle_timeint Integer type. Default keepalive time. Range: 1–120. Unit: minute.
interval_timeint Integer type. Interval between keepalive probes. Range: 25–100. Unit: second.
probe_cntint Integer type. Maximum number of keepalive probes. Range: 3–10.
Returns
String response