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

Public Member Functions

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

Member Function Documentation

◆ set() [1/7]

String set ( int  )
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
Returns
String response

◆ set() [2/7]

String set ( int  ,
String   
)
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid,PDP_type)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
PDP_typeString Packet data protocol type. A string parameter which specifies the type of packet data protocol.
"IP" IPv4
"PPP" PPP
"IPV6" IPv6
"IPV4V6" IPv4v6
"Non-IP" Non-IP
Returns
String response

◆ set() [3/7]

String set ( int  ,
String  ,
String   
)
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid,PDP_type,APN)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
PDP_typeString Packet data protocol type. A string parameter which specifies the type of packet data protocol.
"IP" IPv4
"PPP" PPP
"IPV6" IPv6
"IPV4V6" IPv4v6
"Non-IP" Non-IP
APNString String type. Access point name, a logical name used to select the GGSN or the external packet data network. If the value is null or omitted, then the subscription value will be requested.
Returns
String response

◆ set() [4/7]

String set ( int  ,
String  ,
String  ,
String   
)
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid,PDP_type,APN,PDP_addr)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
PDP_typeString Packet data protocol type. A string parameter which specifies the type of packet data protocol.
"IP" IPv4
"PPP" PPP
"IPV6" IPv6
"IPV4V6" IPv4v6
"Non-IP" Non-IP
APNString String type. Access point name, a logical name used to select the GGSN or the external packet data network. If the value is null or omitted, then the subscription value will be requested.
PDP_addrString String type. Identifies the MT in the address space applicable to the PDP. If the value is null or omitted, then a value may be provided by the TE during the PDP startup procedure or, failing that, a dynamic address will be requested. The allocated address may be read using the AT+CGPADDR command.
Returns
String response

◆ set() [5/7]

String set ( int  ,
String  ,
String  ,
String  ,
int   
)
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid,PDP_type,APN,PDP_addr,data_comp)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
PDP_typeString Packet data protocol type. A string parameter which specifies the type of packet data protocol.
"IP" IPv4
"PPP" PPP
"IPV6" IPv6
"IPV4V6" IPv4v6
"Non-IP" Non-IP
APNString String type. Access point name, a logical name used to select the GGSN or the external packet data network. If the value is null or omitted, then the subscription value will be requested.
PDP_addrString String type. Identifies the MT in the address space applicable to the PDP. If the value is null or omitted, then a value may be provided by the TE during the PDP startup procedure or, failing that, a dynamic address will be requested. The allocated address may be read using the AT+CGPADDR command.
data_compint A numeric parameter that controls PDP data compression (applicable for SNDCP only) (refer to 3GPP TS 44.065 [61]).
0 OFF (Default value if the parameter is omitted)
1 ON (Manufacturer preferred compression)
2 V.42bis
Returns
String response

◆ set() [6/7]

String set ( int  ,
String  ,
String  ,
String  ,
int  ,
int   
)
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid,PDP_type,APN,PDP_addr,data_comp,head_comp)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
PDP_typeString Packet data protocol type. A string parameter which specifies the type of packet data protocol.
"IP" IPv4
"PPP" PPP
"IPV6" IPv6
"IPV4V6" IPv4v6
"Non-IP" Non-IP
APNString String type. Access point name, a logical name used to select the GGSN or the external packet data network. If the value is null or omitted, then the subscription value will be requested.
PDP_addrString String type. Identifies the MT in the address space applicable to the PDP. If the value is null or omitted, then a value may be provided by the TE during the PDP startup procedure or, failing that, a dynamic address will be requested. The allocated address may be read using the AT+CGPADDR command.
data_compint A numeric parameter that controls PDP data compression (applicable for SNDCP only) (refer to 3GPP TS 44.065 [61]).
0 OFF (Default value if the parameter is omitted)
1 ON (Manufacturer preferred compression)
2 V.42bis
head_compint Integer type. Controls PDP header compression (refer to 3GPP TS 44.065 [61] and 3GPP TS 25.323 [62]).
0 OFF
1 ON
2 RFC 1144
3 RFC 2507
4 RFC 3095
Returns
String response

◆ set() [7/7]

String set ( int  ,
String  ,
String  ,
String  ,
int  ,
int  ,
int   
)
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.set(cid,PDP_type,APN,PDP_addr,data_comp,head_comp,IPv4AddrAlloc)
Parameters
cidint Integer type. PDP context identifier, which specifies a particular PDP context definition. The parameter is local to the TE-MT interface and is used in other PDP context-related commands. The range of permitted values (minimum value = 1) is returned by the test form of the command. Range: 1–15.
PDP_typeString Packet data protocol type. A string parameter which specifies the type of packet data protocol.
"IP" IPv4
"PPP" PPP
"IPV6" IPv6
"IPV4V6" IPv4v6
"Non-IP" Non-IP
APNString String type. Access point name, a logical name used to select the GGSN or the external packet data network. If the value is null or omitted, then the subscription value will be requested.
PDP_addrString String type. Identifies the MT in the address space applicable to the PDP. If the value is null or omitted, then a value may be provided by the TE during the PDP startup procedure or, failing that, a dynamic address will be requested. The allocated address may be read using the AT+CGPADDR command.
data_compint A numeric parameter that controls PDP data compression (applicable for SNDCP only) (refer to 3GPP TS 44.065 [61]).
0 OFF (Default value if the parameter is omitted)
1 ON (Manufacturer preferred compression)
2 V.42bis
head_compint Integer type. Controls PDP header compression (refer to 3GPP TS 44.065 [61] and 3GPP TS 25.323 [62]).
0 OFF
1 ON
2 RFC 1144
3 RFC 2507
4 RFC 3095
IPv4AddrAllocint Integer type. Controls how the MT/TA requests to get the IPv4 address information.
0 IPv4 address allocation through NAS signaling
Returns
String response

◆ get()

String get ( )
Description
This api specifies PDP context parameters for a specific context <cid>.
Syntax
bg77.cgdcont.get()
Returns
String response