u-blox

Device lock

Enter PIN +CPIN

+CPIN
Modules
All products
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
No
No
No
< 10 s
+CME Error

Description

Enter PIN. If no PIN request is pending, the corresponding error code is returned. If a wrong PIN is given three times, the PUK must be inserted in place of the PIN, followed by the <newpin> which replaces the old pin in the SIM.

Syntax

TypeSyntaxResponseExample
Set
AT+CPIN=<pin>[,<newpin>]
OK
AT+CPIN="0933"
OK
Read
AT+CPIN?
+CPIN: <code>
OK
+CPIN: SIM PIN
OK
Test
AT+CPIN=?
OK

Defined values

ParameterTypeDescription
<pin>, <newpin>
String
4-to-8 characters long string of decimal digits.
If only PIN is required, <newpin> is not to be entered.
If PUK is required, <pin> must be the PUK and <newpin>, the new PIN code, must be entered as well.
<code>
String
  • READY: MT is not pending for any password
  • SIM PIN: MT is waiting SIM PIN to be given
  • SIM PUK: MT is waiting SIM PUK to be given
  • SIM PIN2: MT is waiting SIM PIN2 to be given
  • SIM PUK2: MT is waiting SIM PUK2 to be given
  • PH-NET PIN: MT is waiting network personalization password to be given
  • PH-NETSUB PIN: MT is waiting network subset personalization password to be given
  • PH-SP PIN: MT is waiting service provider personalization password to be given
  • PH-CORP PIN: MT is waiting corporate personalization password to be given
  • PH-SIM PIN: MT is waiting phone to SIM/UICC card password to be given

Notes

  • The command needs the SIM module to work correctly
  • If PIN is not inserted the following situation can occur:
    CommandResponse
    AT+CMEE=2
    OK
    AT+COPS=0
    +CME ERROR: SIM PIN required
    AT+CMEE=0
    OK
    AT+COPS=0
    ERROR
  • To change the PIN the user must use the AT+CPWD="SC",<old_pin>,<new_pin> command (see +CPWD AT command for details). Example:
AT+CPWD="SC","1234","4321"

Facility lock +CLCK

+CLCK
Modules
All products
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
Yes
No
Yes
Up to 3 min
+CME Error

Description

Locks, unlocks or interrogates an MT or a network facility <fac>. A password is normally needed to do such actions. When querying the status of a network service (<mode>=2) the information text response for "not active" case (<status>=0) is returned only if the service is not active for any <class>. Instead when querying the status of a network service (<mode>=2) asking for a specific <class>, the DUT sends a generic request. The command can be aborted if network facilities are set or interrogated.
For <fac> "PN", "PU", "PP", "PC" and "PS" only <mode>=0 and <mode>=2 (unlock and query status) are always supported.
For <fac> "PN", "PU", "PP", "PC" and "PS" <mode>=1 (lock status) is supported only if proper re-activation characteristic is enabled during personalization.

Syntax

TypeSyntaxResponseExample
Set
AT+CLCK=<fac>,<mode>[,<passwd>[,<class>]]
OK
or
+CLCK: <status>[,<class1>]
[…​]
[+CLCK: <status>[,<class1>]]
OK
AT+CLCK="SC",1,"0933"
OK
Test
AT+CLCK=?
+CLCK: (list of supported <fac>s)
OK
+CLCK: ("SC","PN","PU","PP","PC","PS","FD","AO","OI","OX","AI","IR","AB","AG","AC")
OK

Defined values

ParameterTypeDescription
<fac>
String
Facility values. Allowed values (for the applicability to the module see Table 7):
  • "SC": SIM (PIN enabled/disabled)
  • "PN": Network Personalisation (see the 3GPP TS 22.022 [32])
  • "PU": network sUbset Personalisation (see the 3GPP TS 22.022 [32])
  • "PP": service Provider Personalisation (see the 3GPP TS 22.022 [32])
  • "PC": Corporate Personalisation (see the 3GPP TS 22.022 [32])
  • "PS": SIM/USIM Personalisation (see the 3GPP TS 22.022 [32])
  • "FD": SIM fixed dialling phonebook feature
  • "AO": BAR (Bar All Outgoing Calls)
  • "OI": BOIC (Bar Outgoing International Calls)
  • "OX": BOIC-exHC(Bar Outgoing International Calls except to Home Country)
  • "AI": BAIC (Bar All Incoming Calls)
  • "IR": BIC-Roam (Bar Incoming Calls when Roaming outside the home country)
  • "AB": All Barring services (applicable only for <mode>=0)
  • "AG": All outGoing barring services (applicable only for <mode>=0)
  • "AC": All inComing barring services (applicable only for <mode>=0)
  • "CS": CNTRL (lock CoNTRoL surface (e.g. phone keyboard)) (see the 3GPP TS 27.007 [9])
  • "PF": Lock Phone to the very First inserted SIM/UICC card (see the 3GPP TS 27.007 [9])
  • "NT": Barr incoming calls from numbers Not stored to TA memory (see the 3GPP TS 27.007 [9])
  • "NM": Barr incoming calls from numbers Not stored to MT memory (see 3GPP TS 27.007 [9])
  • "NS": Barr incoming calls from numbers Not stored to SIM/UICC memory (see the 3GPP TS 27.007 [9])
  • "NA": Barr incoming calls from numbers Not stored in any memory (see the 3GPP TS 27.007 [9])
<mode>
Number
  • 0: unlock
  • 1: lock
  • 2: query status
<status>
Number
  • 0: not active
  • 1: active
<passwd>
String
Shall be the same as password specified for the facility from the MT user interface or with the +CPWD command
<class>
Number
Sum of numbers each representing a class of information. The default value is 7 (voice + data + fax):
  • 1: voice
  • 2: data
  • 4: FAX
  • 8: short message service
  • 16: data circuit sync
  • 32: data circuit async
  • 64: dedicated packet access
  • 128: dedicated PAD access

Notes

Table 7. Lock applicability (<fac> allowed values)
Module seriesSCPNPUPPPCPSFDAOOIOXAIIRABAGACCSPFNTNMNSNA
LEXI-R10
x
  • The PIN insertion is not mandatory before the command execution.

Change password +CPWD

+CPWD
Modules
All products
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
Yes
No
Yes
Up to 3 min
+CME Error

Description

Sets a new password for the facility lock function defined by the +CLCK AT command. The command is abortable if a character is sent to the DCE during the command execution.

Syntax

TypeSyntaxResponseExample
Set
AT+CPWD=<fac>,<oldpwd>,<newpwd>
OK
AT+CPWD="SC","0933","0934"
OK
Test
AT+CPWD=?
+CPWD: list of available (<fac>,<pwdlength>s)
OK
+CPWD: ("SC",8),("P2",8),("AO",4),("OI",4),("OX",4),("AI",4),("IR",4),("AB",4),("AG",4),("AC",4)
OK

Defined values

ParameterTypeDescription
<fac>
String
"P2" SIM PIN2; see the +CLCK command description for other values
<oldpwd>
String
Old password
<newpwd>
String
New password
<pwdlength>
Number
Length of password (digits)

Notes

  • An error result code will be provided when attempting to change the PIN code if either the PIN is blocked or the PIN check is disabled through AT+CLCK command.
  • Only <fac>="SC" is supported.
  • The "+CME ERROR: SIM Failure" error result code is returned when attempting to change the PIN code if the PIN check is disabled through AT+CLCK command.

Remaining PIN retries +CPINR

+CPINR
Modules
All products
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
No
No
No
< 10 s
+CME Error

Description

Reads the number of remaining retries for SIM PIN, SIM PIN2, SIM PUK, SIM PUK2.

Syntax

TypeSyntaxResponseExample
Action
AT+CPINR
+CPINR: <code>,<retries>,<default_retries>
[…​]
+CPINR: <code>,<retries>,<default_retries>
OK
AT+CPINR
+CPINR: "SIM PIN",3,3
+CPINR: "SIM PUK",10,10
+CPINR: "SIM PIN2",3,3
+CPINR: "SIM PUK2",10,10
OK
Set
AT+CPINR=<code>
+CPINR: <code>,<retries>,<default_retries>
OK
AT+CPINR="SIM PIN"
+CPINR: "SIM PIN",3,3
OK
Test
AT+CPINR=?
OK

Defined values

ParameterTypeDescription
<code>
String
Type of PIN. Allowed values:
  • "SIM PIN"
  • "SIM PUK"
  • "SIM PIN2"
  • "SIM PUK2"
<retries>
String
Number of remaining retries per PIN.
<default_retries>
Number
Number of default/initial retries per PIN.
Last updated: 13 January 2025
Need help?Contact Support
Questions?Contact us