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

Public Member Functions

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

Member Function Documentation

◆ set() [1/6]

String set ( String  )
Description
This api operates LwM2M client and handles the behavior of LwM2M session
Syntax
bg77.qlwsvc.set(para)
Parameters
paraString String type.
  • "reg"
  • "dereg"
  • "state"
Returns
String response

◆ set() [2/6]

String set ( String  ,
int   
)
Description
This api operates LwM2M client and handles the behavior of LwM2M session
Syntax
bg77.qlwsvc.set(para,conf1)
Parameters
paraString String type.
  • "reg"
  • "dereg"
  • "lifetime"
  • "update"
  • "state"
conf1int
  • "reg" Integer type. Registration mode.
    • 0 LwM2M Client initiates “registration” after the module reboots.
    • 1 LwM2M Client initiates “registration update” after the module reboots
  • "dereg" Integer type. De-register method.
    • 0 De-registration
    • 1 Factory reset
  • "lifetime" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
  • "update" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
  • "state" Integer type. LwM2M Client identifier. Range: 0–5.
Returns
String response

◆ set() [3/6]

String set ( String  ,
int  ,
int   
)
Description
This api operates LwM2M client and handles the behavior of LwM2M session
Syntax
bg77.qlwsvc.set(para,conf1,conf2)
Parameters
paraString String type.
  • "lifetime"
  • "update"
conf1int
  • "lifetime" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
  • "update" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
conf2int
  • "lifetime" Integer type. The lifetime of the registration. Range: 0–86400. Unit: second.
  • "update" Integer type. Whether the current registration update message contains an object list.
    • 0 Send the registration update message with NULL payload.
    • 1 Send the registration update message with object list.
Returns
String response

◆ set() [4/6]

String set ( String  ,
int  ,
String  ,
int  ,
String   
)
Description
This api operates LwM2M client and handles the behavior of LwM2M session
Syntax
bg77.qlwsvc.set(para,conf1,conf2,conf3,conf4)
Parameters
paraString String type.
  • "uldata"
conf1int
  • "uldata" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
conf2String
  • "uldata" String type. The format of URI is /<Object id>="">/<Instance id>="">/<Resource id>="">.
conf3int
  • "uldata" Integer type. Length of the application data. Range: 1–1460. Unit: byte.
conf4String
  • "uldata" String type. Application data to be sent.
Returns
String response

◆ set() [5/6]

String set ( String  ,
int  ,
String  ,
int  ,
String  ,
int   
)
Description
This api operates LwM2M client and handles the behavior of LwM2M session
Syntax
bg77.qlwsvc.set(para,conf1,conf2,conf3,conf4,conf5)
Parameters
paraString String type.
  • "uldata"
conf1int
  • "uldata" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
conf2String
  • "uldata" String type. The format of URI is /<Object id>="">/<Instance id>="">/<Resource id>="">.
conf3int
  • "uldata" Integer type. Length of the application data. Range: 1–1460. Unit: byte.
conf4String
  • "uldata" String type. Application data to be sent.
conf5int
  • "uldata" Integer type. Type of the application data.
    • 0 String type. Send application data in string format.
    • 1 Hexadecimal type. Send application data in hexadecimal format.
Returns
String response

◆ set() [6/6]

String set ( String  ,
int  ,
String  ,
int  ,
String  ,
int  ,
int   
)
Description
This api operates LwM2M client and handles the behavior of LwM2M session
Syntax
bg77.qlwsvc.set(para,conf1,conf2,conf3,conf4,conf5,conf6)
Parameters
paraString String type.
  • "uldata"
conf1int
  • "uldata" Integer type. This identifier uniquely identifies each LwM2M Server configured for the LwM2M Client. Range: 1–65534
conf2String
  • "uldata" String type. The format of URI is /<Object id>="">/<Instance id>="">/<Resource id>="">.
conf3int
  • "uldata" Integer type. Length of the application data. Range: 1–1460. Unit: byte.
conf4String
  • "uldata" String type. Application data to be sent.
conf5int
  • "uldata" Integer type. Type of the application data.
    • 0 String type. Send application data in string format.
    • 1 Hexadecimal type. Send application data in hexadecimal format.
conf6int
  • "uldata" Integer type. Message type of the application data to be sent.
    • 0 Confirmable
    • 1 Non-confirmable
Returns
String response