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

Public Member Functions

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

Member Function Documentation

◆ set() [1/6]

String set ( )
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.set()
Returns
String response

◆ set() [2/6]

String set ( int  )
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.set(mode)
Parameters
modeint Integer type.
0 Buffer unsolicited result codes in the TA. If TA result code buffer is full, indications can be buffered in some other place or the oldest indications may be discarded and replaced with the new received indications.
1 Discard indication and reject new received message unsolicited result codes when TA-TE link is reserved (e.g. in data mode). Otherwise forward them directly to the TE.
2 Buffer unsolicited result codes in the TA when TA-TE link is reserved (e.g. in data mode) and flush them to the TE after reservation. Otherwise forward them directly to the TE.
Returns
String response

◆ set() [3/6]

String set ( int  ,
int   
)
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.set(mode,mt)
Parameters
modeint Integer type.
0 Buffer unsolicited result codes in the TA. If TA result code buffer is full, indications can be buffered in some other place or the oldest indications may be discarded and replaced with the new received indications.
1 Discard indication and reject new received message unsolicited result codes when TA-TE link is reserved (e.g. in data mode). Otherwise forward them directly to the TE.
2 Buffer unsolicited result codes in the TA when TA-TE link is reserved (e.g. in data mode) and flush them to the TE after reservation. Otherwise forward them directly to the TE.
mtint Integer type. The rules for storing received SMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), preferred memory storage (AT+CPMS) setting and this value.
0 No SMS-DELIVER indications are routed to the TE.
1 If SMS-DELIVER is stored into ME/TA, indication of the memory location is routed to the TE by using unsolicited result code: +CMTI: <mem>,<index>
2 SMS-DELIVERs (except class 2) are routed directly to the TE using unsolicited result code: +CMT: [<alpha>],<length><CR><LF><pdu> (PDU mode enabled) or +CMT: <oa>,[<alpha>],<scts>[,<tooa>,<fo>,<pid>,<dcs>,<sca>,<tosca>, <length>]<CR><LF><data> (text mode enabled; about parameters in italics, refer to AT+CSDH). Class 2 messages result in indication as defined in <mt>=1.
3 Class 3 SMS-DELIVERs are routed directly to TE by using unsolicited result codes defined in <mt>=2. Messages of other classes result in indication as defined in <mt>=1.
Returns
String response

◆ set() [4/6]

String set ( int  ,
int  ,
int   
)
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.set(mode,mt,bm)
Parameters
modeint Integer type.
0 Buffer unsolicited result codes in the TA. If TA result code buffer is full, indications can be buffered in some other place or the oldest indications may be discarded and replaced with the new received indications.
1 Discard indication and reject new received message unsolicited result codes when TA-TE link is reserved (e.g. in data mode). Otherwise forward them directly to the TE.
2 Buffer unsolicited result codes in the TA when TA-TE link is reserved (e.g. in data mode) and flush them to the TE after reservation. Otherwise forward them directly to the TE.
mtint Integer type. The rules for storing received SMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), preferred memory storage (AT+CPMS) setting and this value.
0 No SMS-DELIVER indications are routed to the TE.
1 If SMS-DELIVER is stored into ME/TA, indication of the memory location is routed to the TE by using unsolicited result code: +CMTI: <mem>,<index>
2 SMS-DELIVERs (except class 2) are routed directly to the TE using unsolicited result code: +CMT: [<alpha>],<length><CR><LF><pdu> (PDU mode enabled) or +CMT: <oa>,[<alpha>],<scts>[,<tooa>,<fo>,<pid>,<dcs>,<sca>,<tosca>, <length>]<CR><LF><data> (text mode enabled; about parameters in italics, refer to AT+CSDH). Class 2 messages result in indication as defined in <mt>=1.
3 Class 3 SMS-DELIVERs are routed directly to TE by using unsolicited result codes defined in <mt>=2. Messages of other classes result in indication as defined in <mt>=1.
bmint Integer type. The rules for storing received CBMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), the setting of Select CBM Types (AT+CSCB) and this value.
0 No CBM indications are routed to the TE.
2 New CBMs are routed directly to the TE using unsolicited result code:
+CBM: <length><CR><LF><pdu> (PDU mode); or
+CBM: <sn>,<mid>,<dcs>,<page>,<pages><CR><LF><data> (text mode)
Returns
String response

◆ set() [5/6]

String set ( int  ,
int  ,
int  ,
int   
)
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.set(mode,mt,bm,ds)
Parameters
modeint Integer type.
0 Buffer unsolicited result codes in the TA. If TA result code buffer is full, indications can be buffered in some other place or the oldest indications may be discarded and replaced with the new received indications.
1 Discard indication and reject new received message unsolicited result codes when TA-TE link is reserved (e.g. in data mode). Otherwise forward them directly to the TE.
2 Buffer unsolicited result codes in the TA when TA-TE link is reserved (e.g. in data mode) and flush them to the TE after reservation. Otherwise forward them directly to the TE.
mtint Integer type. The rules for storing received SMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), preferred memory storage (AT+CPMS) setting and this value.
0 No SMS-DELIVER indications are routed to the TE.
1 If SMS-DELIVER is stored into ME/TA, indication of the memory location is routed to the TE by using unsolicited result code: +CMTI: <mem>,<index>
2 SMS-DELIVERs (except class 2) are routed directly to the TE using unsolicited result code: +CMT: [<alpha>],<length><CR><LF><pdu> (PDU mode enabled) or +CMT: <oa>,[<alpha>],<scts>[,<tooa>,<fo>,<pid>,<dcs>,<sca>,<tosca>, <length>]<CR><LF><data> (text mode enabled; about parameters in italics, refer to AT+CSDH). Class 2 messages result in indication as defined in <mt>=1.
3 Class 3 SMS-DELIVERs are routed directly to TE by using unsolicited result codes defined in <mt>=2. Messages of other classes result in indication as defined in <mt>=1.
bmint Integer type. The rules for storing received CBMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), the setting of Select CBM Types (AT+CSCB) and this value.
0 No CBM indications are routed to the TE.
2 New CBMs are routed directly to the TE using unsolicited result code:
+CBM: <length><CR><LF><pdu> (PDU mode); or
+CBM: <sn>,<mid>,<dcs>,<page>,<pages><CR><LF><data> (text mode)
       @param   ds    int  
     Integer type.

0 No SMS-STATUS-REPORTs are routed to the TE.
1 SMS-STATUS-REPORTs are routed to the TE using unsolicited result code: +CDS: <length><CR><LF><pdu> (PDU mode) +CDS: <fo>,<mr>,[<ra>],[<tora>],<scts>,,<st> (text mode)
2 If SMS-STATUS-REPORT is stored into ME/TA, indication of the memory location is routed to the TE using unsolicited result code: +CDSI: <mem>,<index>
Returns
String response

◆ set() [6/6]

String set ( int  ,
int  ,
int  ,
int  ,
int   
)
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.set(mode,mt,bm,ds,bfr)
Parameters
modeint Integer type.
0 Buffer unsolicited result codes in the TA. If TA result code buffer is full, indications can be buffered in some other place or the oldest indications may be discarded and replaced with the new received indications.
1 Discard indication and reject new received message unsolicited result codes when TA-TE link is reserved (e.g. in data mode). Otherwise forward them directly to the TE.
2 Buffer unsolicited result codes in the TA when TA-TE link is reserved (e.g. in data mode) and flush them to the TE after reservation. Otherwise forward them directly to the TE.
mtint Integer type. The rules for storing received SMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), preferred memory storage (AT+CPMS) setting and this value.
0 No SMS-DELIVER indications are routed to the TE.
1 If SMS-DELIVER is stored into ME/TA, indication of the memory location is routed to the TE by using unsolicited result code: +CMTI: <mem>,<index>
2 SMS-DELIVERs (except class 2) are routed directly to the TE using unsolicited result code: +CMT: [<alpha>],<length><CR><LF><pdu> (PDU mode enabled) or +CMT: <oa>,[<alpha>],<scts>[,<tooa>,<fo>,<pid>,<dcs>,<sca>,<tosca>, <length>]<CR><LF><data> (text mode enabled; about parameters in italics, refer to AT+CSDH). Class 2 messages result in indication as defined in <mt>=1.
3 Class 3 SMS-DELIVERs are routed directly to TE by using unsolicited result codes defined in <mt>=2. Messages of other classes result in indication as defined in <mt>=1.
bmint Integer type. The rules for storing received CBMs depend on its data coding scheme (refer to 3GPP TS 23.038 [2]), the setting of Select CBM Types (AT+CSCB) and this value.
0 No CBM indications are routed to the TE.
2 New CBMs are routed directly to the TE using unsolicited result code:
+CBM: <length><CR><LF><pdu> (PDU mode); or
+CBM: <sn>,<mid>,<dcs>,<page>,<pages><CR><LF><data> (text mode)
       @param   ds    int  
     Integer type.

0 No SMS-STATUS-REPORTs are routed to the TE.
1 SMS-STATUS-REPORTs are routed to the TE using unsolicited result code: +CDS: <length><CR><LF><pdu> (PDU mode) +CDS: <fo>,<mr>,[<ra>],[<tora>],<scts>,,<st> (text mode)
2 If SMS-STATUS-REPORT is stored into ME/TA, indication of the memory location is routed to the TE using unsolicited result code: +CDSI: <mem>,<index>
       @param   bfr    int  
     Integer type.

0 TA buffer of unsolicited result codes defined within this command is flushed to the TE when <mode> 1 or 2 is entered (OK response shall be given before flushing the codes).
1 TA buffer of unsolicited result codes defined within this command is cleared when <mode> 1or 2 is entered.
Returns
String response

◆ get()

String get ( )
Description
This api selects the procedure on how receiving of new messages from the network is indicated to the TE when TE is active, e.g. DTR is at low level (ON).
Syntax
bg77.cnmi.get()
Returns
String response