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

Public Member Functions

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

Member Function Documentation

◆ get()

String get ( String  )
Description
This api extends configuration settings
Syntax
bg77.qcfgext.get(para)
Parameters
paraString String type.
  • "addgeo"
  • "deletegeo"
  • "querygeo"
  • "nipdcfg"
  • "nipd"
  • "nipds"
  • "nipdr"
  • "dump"
  • "quecopen"
  • "disusb"
  • "usb/event"
  • "fota_apn"
  • "dnsc_timeout"
  • "pwm"
  • "usbnet"
Returns
String response

◆ set() [1/12]

String set ( String  ,
String   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1)
Parameters
paraString String type.
  • "usbnet"
conf1String
  • "usbnet" String type.
    • "rmnet" RmNet interface mode. This interface can accept QMI message. Corresponds to RmNet USB combination: USB DM + NMEA + Modem + RmNet.
    • "ecm" ECM interface mode. The host can connect to the module via USB and use the module as a CDC-Ethernet. Corresponds to ECM USB combination: USB DM + NMEA + Modem + ECM.
    • "modem" Modem interface mode. A second modem port will be additionally enabled for use. Corresponds to Modem USB combination: USB DM + NMEA + Modem + Modem.
Returns
String response

◆ set() [2/12]

String set ( String  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1)
Parameters
paraString String type.
  • "nipdcfg"
  • "nipd"
  • "nipdr"
  • "dnsc_timeout"
  • "dump"
  • "quecopen"
  • "disusb"
  • "pwm"
  • "addgeo"
  • "deletegeo"
  • "querygeo"
conf1int
  • "nipdcfg" Integer type. Non-IP outgoing data type.
    • 0 MO Non-IP data type.
    • 1 MO Exception Non-IP data type.
  • "nipd" Integer type. Close or open an NIDD connection.
    • 0 Close an NIDD connection.
    • 1 Open an NIDD connection.
  • "nipdr" Integer type. The length of the data to be retrieved. Retrieve all available data if this parameter is omitted. Unit: byte.
  • "dnsc_timeout" Integer type. Timeout value for DNS session. Range: 2–300. Default value: 60. Unit: second.
  • "dump" Integer type. Enable/disable dump mode.
    • 0 Disable
    • 1 Enable
  • "quecopen" Integer type. Enable/disable QuecOpen function.
    • 0 Enable
    • 1 Disable
  • "disusb" Integer type. Enable/Disable USB function.
    • 0 Disable
    • 1 Enable
  • "pwm" Integer type. Select the PWM function multiplexed from the corresponding GPIO. 0 BG95 Series: Pin 66, BG77: Pin 33
  • "addgeo" Integer type. Geofence ID. Range: 0–9.
  • "deletegeo" Integer type. Geofence ID. Range: 0–10. 10 means deleting all geofences.
  • "querygeo" Integer type. Geofence ID. Range: 0–9.
Returns
String response

◆ set() [3/12]

String set ( String  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2)
Parameters
paraString String type.
  • "nipd"
  • "nipdr"
  • "pwm"
conf1int
  • "nipd" Integer type. Close or open an NIDD connection.
    • 0 Close an NIDD connection.
    • 1 Open an NIDD connection.
  • "nipdr" Integer type. Close or open an NIDD connection.
    • 0 Close an NIDD connection.
    • 1 Open an NIDD connection.
  • "pwm" Integer type. Select the PWM function multiplexed from the corresponding GPIO. 0 BG95 Series: Pin 66, BG77: Pin 33
conf2int
  • "nipd" Integer type. The timeout value when opening an NIDD connection. This parameter is valid only when <mode>=1. Range: 30–90. Default value: 30. Unit: s.
  • "nipdr" Integer type. Displayed format for <data>. This parameter is valid only when <read_length> is not 0.
  • "pwm" Integer type. Enable/Disable PWM function.
    • 0 Disable
    • 1 Enable
Returns
String response

◆ set() [4/12]

String set ( String  ,
int  ,
int  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "pwm"
conf1int
  • "pwm" Integer type. Select the PWM function multiplexed from the corresponding GPIO. 0 BG95 Series: Pin 66, BG77: Pin 33
conf2int
  • "pwm" Integer type. Enable/Disable PWM function.
    • 0 Disable
    • 1 Enable
conf3int
  • "pwm" Integer type. Set the percentage of PWM duty cycle. Range: 1–99. It is valid only when <state>=1.
conf4int
  • "pwm" Integer type. Set the frequency of PWM. Range: 293–600000. Unit: Hz. It is valid only when <state>=1.
Returns
String response

◆ set() [5/12]

String set ( String  ,
int  ,
String   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2)
Parameters
paraString String type.
  • "nipdcfg"
  • "nipds"
  • "fota_apn"
conf1int
  • "nipdcfg" Integer type. Non-IP outgoing data type.
    • 0 MO Non-IP data type.
    • 1 MO Exception Non-IP data type.
  • "nipds" Integer type. Input format for <data>.
    • 0 ASCII format string.
    • 1 Hex format string.
  • "fota_apn" Integer type. IP family.
    • 0 IPv4 address family
    • 1 IPv6 address family
    • 2 IPv4 and IPv6 address family
conf2String
  • "nipdcfg" String type. Access point name.
  • "nipds" ASCII format string or hex format string. The data to be sent.
  • "fota_apn" String type. Access point name.
Returns
String response

◆ set() [6/12]

String set ( String  ,
int  ,
String  ,
String  ,
String   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "nipdcfg"
  • "fota_apn"
conf1int
  • "nipdcfg" Integer type. Non-IP outgoing data type.
    • 0 MO Non-IP data type.
    • 1 MO Exception Non-IP data type.
  • "fota_apn" Integer type. IP family.
    • 0 IPv4 address family
    • 1 IPv6 address family
    • 2 IPv4 and IPv6 address family
conf2String
  • "nipdcfg" String type. Access point name.
  • "fota_apn" String type. Access point name.
conf3String
  • "nipdcfg" String type. Username of the selected APN.
  • "fota_apn" String type. Username of the selected APN.
conf4String
  • "nipdcfg" String type. Password of the selected APN.
  • "fota_apn" String type. Password of the selected APN.
Returns
String response

◆ set() [7/12]

String set ( String  ,
int  ,
String  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3)
Parameters
paraString String type.
  • "nipds"
conf1int
  • "nipds" Integer type. Input format for <data>.
    • 0 ASCII format string.
    • 1 Hex format string.
conf2String
  • "nipds" ASCII format string or hex format string. The data to be sent.
conf3int
  • "nipds" Integer type. The length of the data to be sent. Range: 1–1358 for ASCII format; 1–679 for hex format. Unit: byte. If this parameter is omitted, <data> can be of any length within 1358 bytes of ASCII format, or within 679 bytes of hex format.
Returns
String response

◆ set() [8/12]

String set ( String  ,
int  ,
String  ,
int  ,
int   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "nipds"
conf1int
  • "nipds" Integer type. Input format for <data>.
    • 0 ASCII format string.
    • 1 Hex format string.
conf2String
  • "nipds" ASCII format string or hex format string. The data to be sent.
conf3int
  • "nipds" Integer type. The length of the data to be sent. Range: 1–1358 for ASCII format; 1–679 for hex format. Unit: byte. If this parameter is omitted, <data> can be of any length within 1358 bytes of ASCII format, or within 679 bytes of hex format.
conf4int
  • "nipds" Integer type. Whether to enable RAI flag when sending data to network side.
    • 0 Disable.
    • 1 Enable.
Returns
String response

◆ set() [9/12]

String set ( String  ,
int  ,
int  ,
int  ,
float  ,
float  ,
float   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4,conf5,conf6)
Parameters
paraString String type.
  • "addgeo"
conf1int
  • "addgeo" Integer type. Geofence ID. Range: 0–9.
conf2int
  • "addgeo" Integer type. URC report mode.
    • 0 Disable URC to be reported when the module enters or leaves the geofence.
    • 1 Enable URC to be reported when the module enters the geofence.
    • 2 Enable URC to be reported when the module leaves the geofence.
    • 3 Enable URC to be reported when the module enters or leaves the geofence.
conf3int
  • "addgeo" Integer type. Geofence shape.
    • 0 Circle with center and radius.
    • 1 Circle with center and one point on the circle.
    • 2 Triangle.
    • 3 Quadrangle.
conf4float
  • "addgeo" The latitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf5float
  • "addgeo" The longitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000.
conf6float
  • "addgeo" When <shape> is 0, this parameter is a radius. Range: 0–6000000. Unit: meter. When <shape> is other values, this parameter is the latitude of the point on the circle or the second point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000. If <shape> is 0, the parameters after <lat2> must be omitted.
Returns
String response

◆ set() [10/12]

String set ( String  ,
int  ,
int  ,
int  ,
float  ,
float  ,
float  ,
float   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4,conf5,conf6,conf7)
Parameters
paraString String type.
  • "addgeo"
conf1int
  • "addgeo" Integer type. Geofence ID. Range: 0–9.
conf2int
  • "addgeo" Integer type. URC report mode.
    • 0 Disable URC to be reported when the module enters or leaves the geofence.
    • 1 Enable URC to be reported when the module enters the geofence.
    • 2 Enable URC to be reported when the module leaves the geofence.
    • 3 Enable URC to be reported when the module enters or leaves the geofence.
conf3int
  • "addgeo" Integer type. Geofence shape.
    • 0 Circle with center and radius.
    • 1 Circle with center and one point on the circle.
    • 2 Triangle.
    • 3 Quadrangle.
conf4float
  • "addgeo" The latitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf5float
  • "addgeo" The longitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000.
conf6float
  • "addgeo" When <shape> is 0, this parameter is a radius. Range: 0–6000000. Unit: meter. When <shape> is other values, this parameter is the latitude of the point on the circle or the second point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000. If <shape> is 0, the parameters after <lat2> must be omitted.
conf7float
  • "addgeo" The longitude of the point on the circle or the second point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000. If <shape> is 1, the parameters after <lon2> must be omitted.
Returns
String response

◆ set() [11/12]

String set ( String  ,
int  ,
int  ,
int  ,
float  ,
float  ,
float  ,
float  ,
float  ,
float   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4,conf5,conf6,conf7,conf8,conf9)
Parameters
paraString String type.
  • "addgeo"
conf1int
  • "addgeo" Integer type. Geofence ID. Range: 0–9.
conf2int
  • "addgeo" Integer type. URC report mode.
    • 0 Disable URC to be reported when the module enters or leaves the geofence.
    • 1 Enable URC to be reported when the module enters the geofence.
    • 2 Enable URC to be reported when the module leaves the geofence.
    • 3 Enable URC to be reported when the module enters or leaves the geofence.
conf3int
  • "addgeo" Integer type. Geofence shape.
    • 0 Circle with center and radius.
    • 1 Circle with center and one point on the circle.
    • 2 Triangle.
    • 3 Quadrangle.
conf4float
  • "addgeo" The latitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf5float
  • "addgeo" The longitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000.
conf6float
  • "addgeo" When <shape> is 0, this parameter is a radius. Range: 0–6000000. Unit: meter. When <shape> is other values, this parameter is the latitude of the point on the circle or the second point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000. If <shape> is 0, the parameters after <lat2> must be omitted.
conf7float
  • "addgeo" The longitude of the point on the circle or the second point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000. If <shape> is 1, the parameters after <lon2> must be omitted.
conf8float
  • "addgeo" The latitude of the third point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf9float
  • "addgeo" The longitude of the third point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000. If <shape> is 2, the parameters after <lon3> must be omitted
Returns
String response

◆ set() [12/12]

String set ( String  ,
int  ,
int  ,
int  ,
float  ,
float  ,
float  ,
float  ,
float  ,
float  ,
float  ,
float   
)
Description
This api extends configuration settings
Syntax
bg77.qcfgext.set(para,conf1,conf2,conf3,conf4,conf5,conf6,conf7,conf8,conf9,conf10,conf11)
Parameters
paraString String type.
  • "addgeo"
conf1int
  • "addgeo" Integer type. Geofence ID. Range: 0–9.
conf2int
  • "addgeo" Integer type. URC report mode.
    • 0 Disable URC to be reported when the module enters or leaves the geofence.
    • 1 Enable URC to be reported when the module enters the geofence.
    • 2 Enable URC to be reported when the module leaves the geofence.
    • 3 Enable URC to be reported when the module enters or leaves the geofence.
conf3int
  • "addgeo" Integer type. Geofence shape.
    • 0 Circle with center and radius.
    • 1 Circle with center and one point on the circle.
    • 2 Triangle.
    • 3 Quadrangle.
conf4float
  • "addgeo" The latitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf5float
  • "addgeo" The longitude of a point which is defined as the center of the geofence circular region or the first point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000.
conf6float
  • "addgeo" When <shape> is 0, this parameter is a radius. Range: 0–6000000. Unit: meter. When <shape> is other values, this parameter is the latitude of the point on the circle or the second point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000. If <shape> is 0, the parameters after <lat2> must be omitted.
conf7float
  • "addgeo" The longitude of the point on the circle or the second point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000. If <shape> is 1, the parameters after <lon2> must be omitted.
conf8float
  • "addgeo" The latitude of the third point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf9float
  • "addgeo" The longitude of the third point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000. If <shape> is 2, the parameters after <lon3> must be omitted
conf10float
  • "addgeo" The latitude of the fourth point. Unit: degree. Format: ±dd.dddddd. Range: -90.000000 to 90.000000.
conf11float
  • "addgeo" The longitude of the fourth point. Unit: degree. Format: ±ddd.dddddd. Range: -180.000000 to 180.000000.
Returns
String response