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

Public Member Functions

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

Member Function Documentation

◆ get()

String get ( String  )
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.get(para)
Parameters
paraString String type.
  • "autostart"
  • "pdpcid"
  • "security"
  • "server"
  • "epns"
  • "transcfg"
  • "version"
  • "select"
  • "host"
  • "device"
  • "session"
  • "mbsps"
Returns
String response

◆ set() [1/8]

String set ( String  ,
int   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1)
Parameters
paraString String type.
  • "autostart"
  • "security"
  • "server"
  • "version"
  • "select"
  • "host"
conf1int
  • "autostart" Integer type. Enable or disable starting LwM2M automatically when the module powers on
  • "security" Integer type. LwM2M Client identifier. Range: 0–5.
  • "server" Integer type. LwM2M Client identifier. Range: 0–5.
  • "version" Integer type. LwM2M protocol version.
    • 0 LwM2M protocol version 1.0
    • 1 LwM2M protocol version 1.1
  • "select" Integer type. The built-in LwM2M Server details for network carrier.
    • 0 Factory mode, used to reset all settings of current LwM2M Client
    • 1 Verizon built-in LwM2M Server information
    • 2 AT&T built-in LwM2M Server information
    • 3 T-Mobile built-in LwM2M Server information
    • 4 Telstra built-in LwM2M Server information
    • 5 LG U+ built-in LwM2M Server information
    • 6 NTT DoCoMo built-in LwM2M Server information.
  • "host" Integer type. Instance ID of host device. Supported values are 0 and 1.
Returns
String response

◆ set() [2/8]

String set ( String  ,
int  ,
int   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2)
Parameters
paraString String type.
  • "pdpcid"
  • "select"
  • "host"
  • "session"
conf1int
  • "pdpcid" Integer type. Enable or disable starting LwM2M automatically when the module powers on
  • "select" Integer type. The built-in LwM2M Server details for network carrier.
    • 0 Factory mode, used to reset all settings of current LwM2M Client
    • 1 Verizon built-in LwM2M Server information
    • 2 AT&T built-in LwM2M Server information
    • 3 T-Mobile built-in LwM2M Server information
    • 4 Telstra built-in LwM2M Server information
    • 5 LG U+ built-in LwM2M Server information
    • 6 NTT DoCoMo built-in LwM2M Server information.
  • "host" Integer type. Instance ID of host device. Supported values are 0 and 1.
  • "session" Integer type. DTLS session lifetime. Range: 0–2147483647. Default value: 0. Unit: second.
conf2int
  • "pdpcid" Integer type. PDP context ID of LwM2M Client. Range: 1–16. Default value: 1
  • "select" Interger type. Whether the proloaded LwM2M Server details is for commercial use.
  • "host" Integer type. Resource ID associated with host device instance.
    • 0 Host device ID
    • 1 Host device manufacturer
    • 2 Host device model number
    • 3 Host device software version
  • "session" Integer type. DTLS session resumption timeout. Range: 0–86400. Default value:
  1. Unit: second.
    Returns
    String response

◆ set() [3/8]

String set ( String  ,
int  ,
int  ,
int   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2,conf3)
Parameters
paraString String type.
  • "pdpcid"
  • "epns"
  • "transcfg"
conf1int
  • "pdpcid" Integer type. Enable or disable starting LwM2M automatically when the module powers on
  • "epns" Integer type. Format of endpoint client name.
    • 0 String type. Specify the endpoint client name with string format directly.
    • 1 Integer type. The value is one of the enumeration specified by the module.
  • "transcfg" Integer type. The timeout value for each bootstrap or registration retry upon a failure. Range: 0–2147483647. Default value: 60. Unit: second.
conf2int
  • "pdpcid" Integer type. PDP context ID of LwM2M Client. Range: 1–16. Default value: 1
  • "epns" Endpoint client name for indentifying bootstrap server. The format is determined by <type>.
  • "transcfg" Integer type. Value by which the timeout for bootstrap or registration retries must be increased exponentially. Range: 0–2147483647. Default value: 2.
conf3int
  • "pdpcid" Integer type. APN class associated with the APN. The list of supported APN class are 0, 2, 3, 6, 7, 10, 11. Default value: 2
  • "epns" Endpoint client name for indentifying standard server. The format is determined by <type>.
  • "transcfg" Integer type. The maximum timeout value for all bootstrap or registration retries upon failures. Range: 0–2147483647. Default value: 480. Unit: second.
Returns
String response

◆ set() [4/8]

String set ( String  ,
int  ,
int  ,
String  ,
int  ,
int   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2,conf3,conf4,conf5)
Parameters
paraString String type.
  • "security"
conf1int
  • "security" Integer type. Enable or disable starting LwM2M automatically when the module powers on
conf2int
  • "security" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534.
conf3String
  • "security" String type. LwM2M Server URI. The maximum length is 255 bytes
conf4int
  • "security" Integer type. LwM2M Bootstrap Server flag.
conf5int
  • "security" Integer type. Encryption method for UDP payload.
    • 0 Pre-Shared Key mode
    • 2 Certificate mode
    • 3 No security mode
Returns
String response

◆ set() [5/8]

String set ( String  ,
int  ,
int  ,
String  ,
int  ,
int  ,
String  ,
String   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2,conf3,conf4,conf5,conf6,conf7)
Parameters
paraString String type.
  • "security"
conf1int
  • "security" Integer type. Enable or disable starting LwM2M automatically when the module powers on
conf2int
  • "security" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534.
conf3int
  • "security" String type. LwM2M Server URI. The maximum length is 255 bytes
conf4int
  • "security" Integer type. LwM2M Bootstrap Server flag.
conf5int
  • "security" Integer type. Encryption method for UDP payload.
    • 0 Pre-Shared Key mode
    • 2 Certificate mode
    • 3 No security mode
conf6String
  • "security" String type. PSK identity. Only valid when <security_mode>=0.
conf7String
  • "security" String type. PSK secret key. Only valid when <security_mode>=0
Returns
String response

◆ set() [6/8]

String set ( String  ,
int  ,
int  ,
int  ,
int  ,
int  ,
int  ,
String   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2,conf3,conf4,conf5,conf6,conf7)
Parameters
paraString String type.
  • "server"
conf1int
  • "server" Integer type. LwM2M Client identifier. Range: 0–5.
conf2int
  • "server" Integer type. Lifetime of the registration. Range: 0–2147483647. Default value: 0. Unit: second.
conf3int
  • "server" Integer type. Minimum period of an Observation. Range: 0–2147483647. Default value: 0. Unit: second.
conf4int
  • "server" Integer type. Maximum period of an Observation. Range: 0–2147483647. Default value: 0. Unit: second.
conf5int
  • "server" Integer type. The interval to the next connection after disconnecting from the LwM2M Server. Range: 60–2147483647. Default value: 86400. Unit: second.
conf6int
  • "server" Integer type. The LwM2M Client stores or discards “Notify” operations to the LwM2M Server when the LwM2M Server account is disabled or the LwM2M Client is offline.
    • 0 The LwM2M Client stores “Notify” operations
    • 1 The LwM2M Client discards “Notify” operations
conf7String
  • "server" String type. Transport binding mode configured for a LwM2M Client.
Returns
String response

◆ set() [7/8]

String set ( String  ,
int  ,
int  ,
String   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2,conf3)
Parameters
paraString
  • "host"
conf1int
  • "host" Integer type. Instance ID of host device. Supported values are 0 and 1.
conf2int
  • "host" Integer type. Resource ID associated with host device instance.
    • 0 Host device ID
    • 1 Host device manufacturer
    • 2 Host device model number
    • 3 Host device software version
conf3String
  • "host" String type. Host device information.
Returns
String response

◆ set() [8/8]

String set ( String  ,
String  ,
String  ,
String  ,
String  ,
String  ,
String   
)
Description
This api configures the parameters of LwM2M client before connecting to the LwM2M Server
Syntax
bg77.qlwcfg.set(para,conf1,conf2,conf3,conf4,conf5,conf6)
Parameters
paraString String type.
  • "device"
  • "mbsps"
conf1String
  • "device" String type. Device manufacturer.
  • "mbsps" String type. Service code.
conf2String
  • "device" String type. Device model number.
  • "mbsps" String type. Device serial number, such as IMEI number.
conf3String
  • "device" String type. Device hardware version.
  • "mbsps" String type. MSISDN number.
conf4String
  • "device" String type. Device software version.
  • "mbsps" String type. ICCID number
conf5String
  • "device" String type. Device firmware version.
  • "mbsps" String type. Device model name.
conf6String
  • "device" String type. Device type name.
  • "mbsps" String type. Device MAC address.
Returns
String response