RUI3 (RAK Unified Interface 3) - RAK4631
Public Member Functions
bg77::qcfg

Public Member Functions

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

Member Function Documentation

◆ get()

String get ( String  )
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para)
Parameters
paraString String type.
  • "nwscanmode"
  • "servicedomain"
  • "nwscanseq"
  • "band"
  • "celevel"
  • "urc/ri/ring"
  • "urc/ri/smsincoming"
  • "urc/ri/other"
  • "risignaltype"
  • "urc/delay"
  • "ledmode"
  • "gpio"
  • "airplanecontrol"
  • "cmux/urcport"
  • "apready"
  • "nccconf"
  • "psm/enter"
  • "psm/urc"
  • "simeffect"
  • "lapiconf"
  • "nasconfig"
  • "nb1/bandprior"
  • "emmcause"
  • "sibinfo"
  • "emmtimer"
  • "msclass"
  • "ims"
  • "snrscan"
  • "fgiconfig"
  • "sim/onchip"
  • "bip/auth"
  • "timer"
  • "timeupdate"
  • "uartcfg"
  • "dbgctl"
  • "cmux/flowctrl"
  • "fast/poweroff"
  • "bandrestore"
Returns
String response

◆ set() [1/14]

String set ( String  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1)
Parameters
paraString String type.
  • "nwscanmode"
  • "servicedomain"
  • "nwscanseq"
  • "iotopmode"
  • "nccconf"
  • "psm/enter"
  • "psm/urc"
  • "simeffect"
  • "lapiconf"
  • "nasconfig"
  • "irat/timer"
  • "emmcause"
  • "snrsnan"
  • "sim/onchip"
  • "bip/auth"
  • "timer"
  • "timeupdate"
  • "urc/delay"
  • "ledmode"
  • "airplanecontrol"
  • "cmux/urcport"
  • "apready"
  • "dbgctl"
  • "cmux/flowctrl"
conf1int
  • "nwscanmode" Integer type. RAT(s) to be searched for.
    • 0 Automatic (GSM and LTE)
    • 1 GSM only
    • 3 LTE only
  • "servicedomain" Integer type. Service domain to be registered.
    • 1 PS only
    • 2 CS & PS
  • "nwscanseq" Integer type. RATs searching sequence, e.g.: 020301 stands for eMTC → NB-IoT → GSM.
    • 00 Automatic (eMTC → NB-IoT → GSM)
    • 01 GSM
    • 02 eMTC
    • 03 NB-IoT
  • "iotopmode" Integer type. Network category to be searched for under LTE RAT.
    • 0 eMTC
    • 1 NB-IoT
    • 2 eMTC and NB-IoT
  • "nccconf" Hexadecimal value. If any bit is set to 1, it means the corresponding feature is enabled, otherwise it is disabled. The NB-IoT features are as follows:
    • Bit 0 Enable or disable the use of EMM_CP_CIOT
    • Bit 1 Enable or disable the use of EMM_UP_CIOT
    • Bit 2 Enable or disable the use of EMM_S1_U
    • Bit 3 Enable or disable the use of EMM_ER_WITHOUT_PDN
    • Bit 4 Enable or disable the use of EMM_HC_CP_CIOT
    • Bit 5 Enable or disable the use of EMM_SMS_ONLY
    • Bit 6 Enable or disable the use of EMM_PNB_CP_CIOT
    • Bit 7 Enable or disable the use of EMM_PNB_UP_CIOT
    • Bit 8 Enable or disable the use of EMM_EPCO_CIOT
  • "psm/enter" Integer type. Whether to trigger the module into PSM immediately.
    • 0 Enter PSM after T3324 expires
    • 1 Enter PSM immediately after RRC connection release is received.
  • "psm/urc" Integer type. Enable/disable the output of PSM entering indication URC +QPSMTIMER: <TAU_timer>,<T3324_timer>. If enabled, the URC will be reported when RRC connection release is received.
    • 0 Disable
    • 1 Enable
  • "simeffect" Integer type. Enable/disable the RAT search order stored in (U)SIM card.
    • 0 Disable
    • 1 Enable
  • "lapiconf" Integer type. Whether to enable low access priority indication feature.
    • 0 Disable. Forced to disable
    • 1 Enable. Forced to enable
    • 2 Auto. Determined by (U)SIM/EFS
  • "nasconfig" Hexadecimal value. If any bit is set to 1, it means the corresponding feature is enabled, otherwise it is disabled. The NAS related parameters are as follows:
    • Bit 0 Enable or disable the use of NAS_SIGNALLING_PRIORITY
    • Bit 1 Enable or disable the use of NMO_I_BEHAVIOUR
    • Bit 2 Enable or disable the use of ATTACH_WITH_IMSI
    • Bit 3 Enable or disable the use of MINIMUM_PERIODIC_SEARCH_TIMER
    • Bit 4 Enable or disable the use of EXTENDED_ACCESS_BARRING
    • Bit 5 Enable or disable the use of TIMER_T3245_BEHAVIOUR
    • Bit 6 Enable or disable the use of
    • OVERRIDE_NAS_SIGNALLING_LOW_PRIORITY
    • Bit 7 Enable or disable the use of OVERRIDE_EXTENDED_ACCESS_BARRING
    • Bit 8 Enable or disable the use of
    • FAST_FIRST_HIGHER_PRIORITY_PLMN_SEARCH
    • Bit 9 Enable or disable the use of
    • EUTRA_DISABLING_ALLOWED_FOR_EMM_CAUSE_15
    • Bit 10 Enable or disable the use of SM_RETRY_WAIT_TIME
    • Bit 11 Enable or disable the use of SM_RETRY_AT_RAT_CHANGE
    • Bit 12 Enable or disable the use of DEFAULT_DCN_ID
    • Bit 13 Enable or disable the use of EXCEPTION_DATA_REPORTING_ALLOWED
    • Bit 14 Enable or disable the use of LIGHT_CONNECTION
  • "irat/timer" Integer type. Timeout value for high-priority RAT search timer. Range: 5–300. Default: 60. Unit: minute.
  • "emmcause" Integer type. The display format of EMM cause value.
    • 0 Numeric value
    • 1 Verbose value
  • "snrsnan" Integer type. Signal noise ratio level.
    • 0 SNR level 0
    • 1 SNR level 0 & 1
    • 2 SNR level 0 & 1 & 2
  • "sim/onchip" Integer type. Enable/disable on-chip SIM.
    • 0 Disable
    • 1 Enable
  • "bip/auth" Integer type. Auth type.
    • 0 None
    • 1 PAP
    • 2 CHAP
    • 3 PAP or CHAP
  • "timer" Integer type. 3402 T3402 timer. See 3GPP 24.301 for details.
  • "timeupdate" Integer type. Enable/disable automatic time update via NITZ.
    • 0 Disable
    • 1 Enable
  • "urc/delay" Integer type. When to output the URC.
    • 0 Output URC when ring indication pulse starts.
    • 1 Output URC when ring indication pulse ends (effective only when <typeRI>="pulse". Refer to AT+QCFG="urc/ri/ring", AT+QCFG="urc/ri/smsincoming" and AT+QCFG="urc/ri/other" for more details).
  • "ledmode" Integer type. Output mode of NET_STATUS pin.
    • 0 Flicker mode.Network searching: LED is on for 200 ms (high level); LED is off for 1800 ms (low level) Idle: LED is on for 1800 ms (high level); LED is off for 200 ms (low level) Data transfer is ongoing: LED is on for 125 ms (high level); LED is off for 125 ms (low level) Voice calling: always high
    • 1 Output high level when attaching to the network and low level in other conditions.
    • 3 Set NET_STATUS pin as customization mode
  • "airplanecontrol" Integer type. Enable/disable airplane mode control via W_DISABLE# pin.
    • 0 Disable
    • 1 Enable The following URC will be reported when pulling up or down W_DISABLE# pin if airplane mode control via W_DISABLE# pin is enabled: +QIND: "airplanestatus",<airplane_status>
  • "cmux/urcport" Integer type. Output port of CMUX URCs.
    • 0 All ports
    • 1 Virtual port 1
    • 2 Virtual port 2
    • 3 Virtual port 3
    • 4 Virtual port 4
  • "apready" Integer type. Enable/disable the AP_READY pin for AP sleep state detection.
    • 0 Disable
    • 1 Enable
  • "dbgctl" Integer type. Log output level.
    • 0 Enable the log output
    • 1 Partially prohibit the log output
    • 2 Disable the protocol stack log output
  • "cmux/flowctrl" Integer type. Enable/disable hardware flow control for CMUX mode.
    • 0 Disable
    • 1 Enable
Returns
String response

◆ set() [2/14]

String set ( String  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2)
Parameters
paraString String type.
  • "nwscanmode"
  • "servicedomain"
  • "nwscanseq"
  • "iotopmode"
  • "lapiconf"
  • "irat/timer"
  • "msclass"
  • "sim/onchip"
  • "gpio"
  • "apready"
  • "fast/poweroff"
conf1int
  • "nwscanmode" Integer type. RAT(s) to be searched for.
    • 0 Automatic (GSM and LTE)
    • 1 GSM only
    • 3 LTE only
  • "servicedomain" Integer type. Service domain to be registered.
    • 1 PS only
    • 2 CS & PS
  • "nwscanseq" Integer type. RATs searching sequence, e.g.: 020301 stands for eMTC → NB-IoT → GSM.
    • 00 Automatic (eMTC → NB-IoT → GSM)
    • 01 GSM
    • 02 eMTC
    • 03 NB-IoT
  • "iotopmode" Integer type. Network category to be searched for under LTE RAT.
    • 0 eMTC
    • 1 NB-IoT
    • 2 eMTC and NB-IoT
  • "lapiconf" Integer type. Whether to enable low access priority indication feature.
    • 0 Disable. Forced to disable
    • 1 Enable. Forced to enable
    • 2 Auto. Determined by (U)SIM/EFS
  • "irat/timer" Integer type. Timeout value for high-priority RAT search timer. Range: 5–300. Default: 60. Unit: minute.
  • "msclass" Integer type. GPRS multislot class. Range: 0–18, 30–34. Default: 12.
  • "sim/onchip" Integer type. Enable/disable on-chip SIM.
    • 0 Disable
    • 1 Enable
  • "gpio" Integer type. Command mode.
    • 1 Initialize GPIO status
    • 2 Query GPIO status
    • 3 Configure GPIO status
  • "apready" Integer type. Enable/disable the AP_READY pin for AP sleep state detection.
    • 0 Disable
    • 1 Enable
  • "fast/poweroff" Integer type. The corresponding pin number of the GPIO which has an input and pull-up mode and can be triggered by a falling edge for fast shutdown.
    • The corresponding pin number for BG95 series: 25
    • The corresponding pin number for BG77 module: 63
    • The corresponding pin number for BG600L-M3 module: 11
conf2int
  • "nwscanmode" Integer type. When to take effect.
    • 0 Take effect after rebooting
    • 1 Take effect immediately
  • "servicedomain" Integer type. When to take effect.
    • 0 Take effect after rebooting
    • 1 Take effect immediately
  • "nwscanseq" Integer type. When to take effect.
    • 0 Take effect after rebooting
    • 1 Take effect immediately
  • "iotopmode" Integer type. When to take effect.
    • 0 Take effect after rebooting
    • 1 Take effect immediately
  • "lapiconf" Integer type. Whether <mode> takes effect. This parameter is valid only when <mode>=1 or 2.
    • 0 Do not take effect
    • 1 Take effect
  • "irat/timer" Integer type. This parameter specifies the interval before eDRX paging when a scan should begin. Range: 5–20. Default: 20. Unit: minute.
  • "msclass" Integer type. EGPRS multislot class. Range: 0–34. Default: 12.
  • "sim/onchip" Integer type. When to take effect.
    • 0 Take effect after rebooting
    • 1 Take effect immediately
  • "gpio" Integer type. The corresponding pin number of the module’s GPIO. BG77 supports the following pin numbers:
    • 1
    • 2
    • 3
    • 4
    • 5
    • 8
    • 9
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 57
    • 60
    • 61
    • 62
    • 63
    • 76
    • 77
    • 90
  • "apready" Integer type. Valid level of AP_READY. The parameter is valid only when the AP_READY detection function is enabled.
    • 0 Low level
    • 1 High level
  • "fast/poweroff" Integer type. Enable/Disable fast shutdown function.
    • 0 Disable
    • 1 Enable
Returns
String response

◆ set() [3/14]

String set ( String  ,
int  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3)
Parameters
paraString String type.
  • "ledmode"
  • "gpio"
  • "apready"
conf1int
  • "ledmode" Integer type. Output mode of NET_STATUS pin.
    • 0 Flicker mode.Network searching: LED is on for 200 ms (high level); LED is off for 1800 ms (low level) Idle: LED is on for 1800 ms (high level); LED is off for 200 ms (low level) Data transfer is ongoing: LED is on for 125 ms (high level); LED is off for 125 ms (low level) Voice calling: always high
    • 1 Output high level when attaching to the network and low level in other conditions.
    • 3 Set NET_STATUS pin as customization mode
  • "gpio" Integer type. Command mode.
    • 1 Initialize GPIO status
    • 2 Query GPIO status
    • 3 Configure GPIO status
  • "apready" Integer type. Enable/disable the AP_READY pin for AP sleep state detection.
    • 0 Disable
    • 1 Enable
conf2int
  • "ledmode" Integer type. The high-level duration of NET_STATUS pin in customization mode. Range: 0–60000. Default: 500. Unit: ms.
  • "gpio" Integer type. The corresponding pin number of the module’s GPIO. BG77 supports the following pin numbers:
    • 1
    • 2
    • 3
    • 4
    • 5
    • 8
    • 9
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 57
    • 60
    • 61
    • 62
    • 63
    • 76
    • 77
    • 90
  • "apready" Integer type. Valid level of AP_READY. The parameter is valid only when the AP_READY detection function is enabled.
    • 0 Low level
    • 1 High level
conf3int
  • "ledmode" Integer type. The low-level duration of NET_STATUS pin in customization mode. Range: 0–60000. Default: 500. Unit: ms.
  • "gpio" Integer type. Whether to save the configurations.
    • 0 Not save
    • 1 Save
  • "apready" Integer type. Detection interval. Range: 100–3000. Default: 500. Unit: ms. This parameter is valid only when the AP_READY detection function is enabled.
Returns
String response

◆ set() [4/14]

String set ( String  ,
String   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1)
Parameters
paraString String type.
  • "nb1/bandprior"
  • "fgiconfig"
  • "urc/ri/ring"
  • "urc/ri/smsincoming"
  • "urc/ri/other"
  • "risignaltype"
  • "uartcfg"
conf1String
  • "nb1/bandprior" Hex string. NB-IoT band(s) of scan priority.
    • 01 Band 1
    • 02 Band 2
    • 03 Band 3
    • 04 Band 4
    • 05 Band 5
    • 08 Band 8
    • 0C Band 12
    • 0D Band 13
    • 12 Band 18
    • 13 Band 19
    • 14 Band 20
    • 19 Band 25
    • 1C Band 28
    • 1F Band 31
    • 42 Band 66
    • 47 Band 71
    • 48 Band 72
    • 49 Band 73
    • 55 Band 85
  • "fgiconfig" Hexadecimal value. Feature group indicators (FGI). Range: 0–0xFFFFFFFF. See 3GPP 36.331.
  • "urc/ri/ring" String type. The behavior of MAIN_RI pin when URC RING is presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
    • "auto" When RING is presented to indicate an incoming call, MAIN_RI changes to active and keeps active. When the ring of the incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
    • "wave" When RING is presented to indicate an incoming call, MAIN_RI outputs a square wave. Both <active_duration> and <inactive_duration> are used to set the square wave. When the ring of incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
  • "urc/ri/smsincoming" String type. MAIN_RI behavior implemented when SMS URCs are presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
  • "urc/ri/other" String type. MAIN_RI behavior when other URCs are presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
  • "risignaltype" String type. MAIN_RI signal output carrier.
    • "respective" MAIN_RI behavior on the port where URC is presented. For example, if URC is presented on UART port, it is a physical ring indication signal. If URC is presented on USB modem port, it is a virtual ring indication signal. AT+QURCCFG="urcport" can get the port on which URC is presented, and see document [1] for details of the AT command.
    • "physical" No matter on which port the URC is presented, it only causes the behavior of physical ring indication signal.
  • "uartcfg" Hexadecimal value. Enable/Disable DCD/RI/DTR/RTS/CTS function.
    • 0x00 Enable DCD/RI/DTR/RTS/CTS function
    • 0x01 Disable DCD function
    • 0x02 Disable RI function
    • 0x04 Disable DTR function
    • 0x08 Disable RTS function
    • 0x10 Disable CTS function
Returns
String response

◆ set() [5/14]

String set ( String  ,
String  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2)
Parameters
paraString String type.
  • "urc/ri/ring"
  • "urc/ri/smsincoming"
  • "urc/ri/other"
conf1String
  • "urc/ri/ring" String type. The behavior of MAIN_RI pin when URC RING is presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
    • "auto" When RING is presented to indicate an incoming call, MAIN_RI changes to active and keeps active. When the ring of the incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
    • "wave" When RING is presented to indicate an incoming call, MAIN_RI outputs a square wave. Both <active_duration> and <inactive_duration> are used to set the square wave. When the ring of incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
  • "urc/ri/smsincoming" String type. MAIN_RI behavior implemented when SMS URCs are presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
  • "urc/ri/other" String type. MAIN_RI behavior when other URCs are presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
conf2int
  • "urc/ri/ring" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
  • "urc/ri/smsincoming" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
  • "urc/ri/other" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
Returns
String response

◆ set() [6/14]

String set ( String  ,
String  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3)
Parameters
paraString String type.
  • "urc/ri/ring"
  • "urc/ri/smsincoming"
  • "urc/ri/other"
conf1String
  • "urc/ri/ring" String type. The behavior of MAIN_RI pin when URC RING is presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
    • "auto" When RING is presented to indicate an incoming call, MAIN_RI changes to active and keeps active. When the ring of the incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
    • "wave" When RING is presented to indicate an incoming call, MAIN_RI outputs a square wave. Both <active_duration> and <inactive_duration> are used to set the square wave. When the ring of incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
  • "urc/ri/smsincoming" String type. MAIN_RI behavior implemented when SMS URCs are presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
  • "urc/ri/other" String type. MAIN_RI behavior when other URCs are presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
conf2int
  • "urc/ri/ring" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
  • "urc/ri/smsincoming" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
  • "urc/ri/other" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
conf3int
  • "urc/ri/ring" Integer type. The active duration of square wave. Range: 1–10000. Default:
  1. Unit: ms. This parameter is valid only when <typeRI>="wave".
    • "urc/ri/smsincoming" Integer type. The count of pulse. It is valid only when <typeRI>="pulse". Range: 1–5. Default: 1. The interval time between two pulses is equal to <pulse_duration>
    • "urc/ri/other" Integer type. The count of pulse. This parameter is valid only when <typeRI>="pulse". Range: 1–5. Default: 1. The interval time between two pulses is equal to <pulse_duration>.
    Returns
    String response

◆ set() [7/14]

String set ( String  ,
String  ,
int  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "urc/ri/ring"
conf1String
  • "urc/ri/ring" String type. The behavior of MAIN_RI pin when URC RING is presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
    • "auto" When RING is presented to indicate an incoming call, MAIN_RI changes to active and keeps active. When the ring of the incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
    • "wave" When RING is presented to indicate an incoming call, MAIN_RI outputs a square wave. Both <active_duration> and <inactive_duration> are used to set the square wave. When the ring of incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
conf2int
  • "urc/ri/ring" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
conf3int
  • "urc/ri/ring" Integer type. The active duration of square wave. Range: 1–10000. Default:
  1. Unit: ms. This parameter is valid only when <typeRI>="wave".
    Parameters
    conf4int Integer type. The inactive duration of square wave. Range: 1–10000. Default:
  2. Unit: ms. This parameter is valid only when <typeRI>="wave".
    Returns
    String response

◆ set() [8/14]

String set ( String  ,
String  ,
int  ,
int  ,
int  ,
String   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4,conf5)
Parameters
paraString String type.
  • ""urc/ri/ring"
conf1String
  • ""urc/ri/ring" String type. The behavior of MAIN_RI pin when URC RING is presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
    • "auto" When RING is presented to indicate an incoming call, MAIN_RI changes to active and keeps active. When the ring of the incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
    • "wave" When RING is presented to indicate an incoming call, MAIN_RI outputs a square wave. Both <active_duration> and <inactive_duration> are used to set the square wave. When the ring of incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
conf2int
  • ""urc/ri/ring" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
conf3int
  • ""urc/ri/ring" Integer type. The active duration of square wave. Range: 1–10000. Default:
  1. Unit: ms. This parameter is valid only when <typeRI>="wave".
    Parameters
    conf4int
    • ""urc/ri/ring" Integer type. The inactive duration of square wave. Range: 1–10000. Default:
  2. Unit: ms. This parameter is valid only when <typeRI>="wave".
    Parameters
    conf5String
    • ""urc/ri/ring" String type. Set whether the MAIN_RI behavior could be disturbed. This parameter is valid only when <typeRI>="auto" or "wave". For example, when <typeRI>="wave", if you want the square wave not to be disturbed by other URCs (including SMS related URCs), then <ring_no_disturbing> should be set to "on".
      • "off" MAIN_RI behavior can be disturbed by other URCs when the behavior is caused by an incoming call ringing.
      • "on" MAIN_RI behavior cannot be disturbed by other URCs when the behavior is caused by an incoming call ringing.
    Returns
    String response

◆ set() [9/14]

String set ( String  ,
String  ,
int  ,
int  ,
int  ,
String  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4,conf5,conf6)
Parameters
paraString String type.
  • ""urc/ri/ring"
conf1String
  • ""urc/ri/ring" String type. The behavior of MAIN_RI pin when URC RING is presented.
    • "off" No change. MAIN_RI keeps inactive (high level).
    • "pulse" Pulse. Pulse width is determined by <pulse_duration>.
    • "always" Change to active. MAIN_RI behavior can be restored to inactive by AT+QRIR (see document [1] for details).
    • "auto" When RING is presented to indicate an incoming call, MAIN_RI changes to active and keeps active. When the ring of the incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
    • "wave" When RING is presented to indicate an incoming call, MAIN_RI outputs a square wave. Both <active_duration> and <inactive_duration> are used to set the square wave. When the ring of incoming call ends, either answering or hanging up the incoming call changes MAIN_RI to inactive.
conf2int
  • ""urc/ri/ring" Integer type. The width of pulse. Range: 1–2000. Default: 120. Unit: ms. This parameter is valid only when <typeRI>="pulse".
conf3int
  • ""urc/ri/ring" Integer type. The active duration of square wave. Range: 1–10000. Default:
  1. Unit: ms. This parameter is valid only when <typeRI>="wave".
    Parameters
    conf4int
    • ""urc/ri/ring" Integer type. The inactive duration of square wave. Range: 1–10000. Default:
  2. Unit: ms. This parameter is valid only when <typeRI>="wave".
    Parameters
    conf5String
    • ""urc/ri/ring" String type. Set whether the MAIN_RI behavior could be disturbed. This parameter is valid only when <typeRI>="auto" or "wave". For example, when <typeRI>="wave", if you want the square wave not to be disturbed by other URCs (including SMS related URCs), then <ring_no_disturbing> should be set to "on".
      • "off" MAIN_RI behavior can be disturbed by other URCs when the behavior is caused by an incoming call ringing.
      • "on" MAIN_RI behavior cannot be disturbed by other URCs when the behavior is caused by an incoming call ringing.
    conf6String
    • ""urc/ri/ring" Integer type. The count of pulse. This parameter is valid only when <typeRI>="pulse". Range: 1–5. Default: 1. The interval time between two pulses is equal to <pulse_duration>.
    Returns
    String response

◆ set() [10/14]

String set ( String  ,
String  ,
String  ,
String   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3)
Parameters
paraString String type.
  • "band"
conf1String
  • "band" A hexadecimal value that specifies the GSM frequency band (e.g.: 0xa = 0x2(DCS1800) + 0x8(PCS1900)). If it is set to 0, it means not to change GSM frequency band.
    • 0 No change
    • 0x1 EGSM900
    • 0x2 DCS1800
    • 0x4 GSM850
    • 0x8 PCS1900
    • 0xF All of the supported bands above
conf2String
  • "band" A hexadecimal value that specifies the eMTC frequency band (e.g.: 0x15 = 0x1(LTE B1) + 0x4(LTE B3) + 0x10(LTE B5)). If it is set to 0, it means not to change the eMTC frequency band.
    • 0 No change
    • 0x1 (BAND_PREF_LTE_BAND1) LTE B1
    • 0x2 (BAND_PREF_LTE_BAND2) LTE B2
    • 0x4 (BAND_PREF_LTE_BAND3) LTE B3
    • 0x8 (BAND_PREF_LTE_BAND4) LTE B4
    • 0x10 (BAND_PREF_LTE_BAND5) LTE B5
    • 0x80 (BAND_PREF_LTE_BAND8) LTE B8
    • 0x800 (BAND_PREF_LTE_BAND12) LTE B12
    • 0x1000 (BAND_PREF_LTE_BAND13) LTE B13
    • 0x20000 (BAND_PREF_LTE_BAND18) LTE B18
    • 0x40000 (BAND_PREF_LTE_BAND19) LTE B19
    • 0x80000 (BAND_PREF_LTE_BAND20) LTE B20
    • 0x1000000 (BAND_PREF_LTE_BAND25) LTE B25
    • 0x2000000 (BAND_PREF_LTE_BAND26) LTE B26
    • 0x4000000 (BAND_PREF_LTE_BAND27) LTE B27
    • 0x8000000 (BAND_PREF_LTE_BAND28) LTE B28
    • 0x40000000 (BAND_PREF_LTE_BAND31) LTE B31
    • 0x20000000000000000 (BAND_PREF_LTE_BAND66) LTE B66
    • 0x800000000000000000 (BAND_PREF_LTE_BAND72 LTE B72
    • 0x1000000000000000000 (BAND_PREF_LTE_BAND73) LTE B73
    • 0x1000000000000000000000 (BAND_PREF_LTE_BAND85) LTE B85
conf3String
  • "band" A hexadecimal value that specifies the NB-IoT frequency band (e.g.: 0x15 = 0x1(LTE B1) + 0x4(LTE B3) + 0x10(LTE B5)). If it is set to 0, it means not to change the NB-IoT frequency band.
    • 0 No change
    • 0x1 (BAND_PREF_LTE_BAND1) LTE B1
    • 0x2 (BAND_PREF_LTE_BAND2) LTE B2
    • 0x4 (BAND_PREF_LTE_BAND3) LTE B3
    • 0x8 (BAND_PREF_LTE_BAND4) LTE B4
    • 0x10 (BAND_PREF_LTE_BAND5) LTE B5
    • 0x80 (BAND_PREF_LTE_BAND8) LTE B8
    • 0x800 (BAND_PREF_LTE_BAND12) LTE B12
    • 0x1000 (BAND_PREF_LTE_BAND13) LTE B13
    • 0x20000 (BAND_PREF_LTE_BAND18) LTE B18
    • 0x40000 (BAND_PREF_LTE_BAND19) LTE B19
    • 0x80000 (BAND_PREF_LTE_BAND20) LTE B20
    • 0x1000000 (BAND_PREF_LTE_BAND25) LTE B25
    • 0x8000000 (BAND_PREF_LTE_BAND28) LTE B28
    • 0x40000000 (BAND_PREF_LTE_BAND31) LTE B31
    • 0x20000000000000000 (BAND_PREF_LTE_BAND66) LTE B66
    • 0x400000000000000000 (BAND_PREF_LTE_BAND71) LTE B71
    • 0x800000000000000000 (BAND_PREF_LTE_BAND72) LTE B72
    • 0x1000000000000000000 (BAND_PREF_LTE_BAND73) LTE B73
    • 0x1000000000000000000000 (BAND_PREF_LTE_BAND85) LTE B85
Returns
String response

◆ set() [11/14]

String set ( String  ,
String  ,
String  ,
String  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "band"
conf1String
  • "band" A hexadecimal value that specifies the GSM frequency band (e.g.: 0xa = 0x2(DCS1800) + 0x8(PCS1900)). If it is set to 0, it means not to change GSM frequency band.
    • 0 No change
    • 0x1 EGSM900
    • 0x2 DCS1800
    • 0x4 GSM850
    • 0x8 PCS1900
    • 0xF All of the supported bands above
conf2String
  • "band" A hexadecimal value that specifies the eMTC frequency band (e.g.: 0x15 = 0x1(LTE B1) + 0x4(LTE B3) + 0x10(LTE B5)). If it is set to 0, it means not to change the eMTC frequency band.
    • 0 No change
    • 0x1 (BAND_PREF_LTE_BAND1) LTE B1
    • 0x2 (BAND_PREF_LTE_BAND2) LTE B2
    • 0x4 (BAND_PREF_LTE_BAND3) LTE B3
    • 0x8 (BAND_PREF_LTE_BAND4) LTE B4
    • 0x10 (BAND_PREF_LTE_BAND5) LTE B5
    • 0x80 (BAND_PREF_LTE_BAND8) LTE B8
    • 0x800 (BAND_PREF_LTE_BAND12) LTE B12
    • 0x1000 (BAND_PREF_LTE_BAND13) LTE B13
    • 0x20000 (BAND_PREF_LTE_BAND18) LTE B18
    • 0x40000 (BAND_PREF_LTE_BAND19) LTE B19
    • 0x80000 (BAND_PREF_LTE_BAND20) LTE B20
    • 0x1000000 (BAND_PREF_LTE_BAND25) LTE B25
    • 0x2000000 (BAND_PREF_LTE_BAND26) LTE B26
    • 0x4000000 (BAND_PREF_LTE_BAND27) LTE B27
    • 0x8000000 (BAND_PREF_LTE_BAND28) LTE B28
    • 0x40000000 (BAND_PREF_LTE_BAND31) LTE B31
    • 0x20000000000000000 (BAND_PREF_LTE_BAND66) LTE B66
    • 0x800000000000000000 (BAND_PREF_LTE_BAND72 LTE B72
    • 0x1000000000000000000 (BAND_PREF_LTE_BAND73) LTE B73
    • 0x1000000000000000000000 (BAND_PREF_LTE_BAND85) LTE B85
conf3String
  • "band" A hexadecimal value that specifies the NB-IoT frequency band (e.g.: 0x15 = 0x1(LTE B1) + 0x4(LTE B3) + 0x10(LTE B5)). If it is set to 0, it means not to change the NB-IoT frequency band.
    • 0 No change
    • 0x1 (BAND_PREF_LTE_BAND1) LTE B1
    • 0x2 (BAND_PREF_LTE_BAND2) LTE B2
    • 0x4 (BAND_PREF_LTE_BAND3) LTE B3
    • 0x8 (BAND_PREF_LTE_BAND4) LTE B4
    • 0x10 (BAND_PREF_LTE_BAND5) LTE B5
    • 0x80 (BAND_PREF_LTE_BAND8) LTE B8
    • 0x800 (BAND_PREF_LTE_BAND12) LTE B12
    • 0x1000 (BAND_PREF_LTE_BAND13) LTE B13
    • 0x20000 (BAND_PREF_LTE_BAND18) LTE B18
    • 0x40000 (BAND_PREF_LTE_BAND19) LTE B19
    • 0x80000 (BAND_PREF_LTE_BAND20) LTE B20
    • 0x1000000 (BAND_PREF_LTE_BAND25) LTE B25
    • 0x8000000 (BAND_PREF_LTE_BAND28) LTE B28
    • 0x40000000 (BAND_PREF_LTE_BAND31) LTE B31
    • 0x20000000000000000 (BAND_PREF_LTE_BAND66) LTE B66
    • 0x400000000000000000 (BAND_PREF_LTE_BAND71) LTE B71
    • 0x800000000000000000 (BAND_PREF_LTE_BAND72) LTE B72
    • 0x1000000000000000000 (BAND_PREF_LTE_BAND73) LTE B73
    • 0x1000000000000000000000 (BAND_PREF_LTE_BAND85) LTE B85
conf4int
  • "band" Integer type. When to take effect.
    • 0 Take effect after rebooting
    • 1 Take effect immediately
Returns
String response

◆ set() [12/14]

String set ( String  ,
int  ,
int  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "gpio"
conf1int
  • "gpio" Integer type. Command mode.
    • 1 Initialize GPIO status
    • 2 Query GPIO status
    • 3 Configure GPIO status
conf2int
  • "gpio" Integer type. The corresponding pin number of the module’s GPIO. BG77 supports the following pin numbers:
    • 1
    • 2
    • 3
    • 4
    • 5
    • 8
    • 9
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 57
    • 60
    • 61
    • 62
    • 63
    • 76
    • 77
    • 90
conf3int
  • "gpio" Integer type. The value read from or write to a GPIO.
    • 0 Low level
    • 1 High level
conf4int
  • "gpio" Integer type. Whether to save the configurations.
    • 0 Not save
    • 1 Save
Returns
String response

◆ set() [13/14]

String set ( String  ,
int  ,
int  ,
int  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4,conf5)
Parameters
paraString String type.
  • "gpio"
conf1int
  • "gpio" Integer type. Command mode.
    • 1 Initialize GPIO status
    • 2 Query GPIO status
    • 3 Configure GPIO status
conf2int
  • "gpio" Integer type. The corresponding pin number of the module’s GPIO. BG77 supports the following pin numbers:
    • 1
    • 2
    • 3
    • 4
    • 5
    • 8
    • 9
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 57
    • 60
    • 61
    • 62
    • 63
    • 76
    • 77
    • 90
conf3int
  • "gpio" Integer type. GPIO pin direction.
    • 0 Input
    • 1 Output
conf4int
  • "gpio" Integer type. GPIO pin pull type.
    • 0 No pull
    • 1 Pull the GPIO down
    • 2 Keep the GPIO as it is
    • 3 Pull the GPIO up
conf5int
  • "gpio" Integer type. GPIO pin drive strength.
    • 0 2 mA
    • 1 4 mA
    • 2 6 mA
    • 3 8 mA
    • 4 10 mA
    • 5 12 mA
    • 6 14 mA
    • 7 16 mA
Returns
String response

◆ set() [14/14]

String set ( String  ,
int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfg.get(para,conf1,conf2,conf3,conf4,conf5,conf6)
Parameters
paraString String type.
  • "gpio"
conf1int
  • "gpio" Integer type. Command mode.
    • 1 Initialize GPIO status
    • 2 Query GPIO status
    • 3 Configure GPIO status
conf2int
  • "gpio" Integer type. The corresponding pin number of the module’s GPIO. BG77 supports the following pin numbers:
    • 1
    • 2
    • 3
    • 4
    • 5
    • 8
    • 9
    • 33
    • 34
    • 35
    • 36
    • 37
    • 38
    • 39
    • 40
    • 41
    • 57
    • 60
    • 61
    • 62
    • 63
    • 76
    • 77
    • 90
conf3int
  • "gpio" Integer type. GPIO pin direction.
    • 0 Input
    • 1 Output
conf4int
  • "gpio" Integer type. GPIO pin pull type.
    • 0 No pull
    • 1 Pull the GPIO down
    • 2 Keep the GPIO as it is
    • 3 Pull the GPIO up
conf5int
  • "gpio" Integer type. GPIO pin drive strength.
    • 0 2 mA
    • 1 4 mA
    • 2 6 mA
    • 3 8 mA
    • 4 10 mA
    • 5 12 mA
    • 6 14 mA
    • 7 16 mA
conf6int
  • "gpio" Integer type. Whether to save the configurations.
    • 0 Not save
    • 1 Save
Returns
String response