u-blox

Lightweight M2M

LwM2M Objects management

LwM2M connectivity

LwM2M URCs configuration +ULWM2MSTAT

+ULWM2MSTAT
Modules
LEXI-R10401D
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
No
NVM
No
65
+CME Error

LEXI-R10401D-00B Description

Configures the URC reporting status for LwM2M client. The URC assumes a different syntax and meaning depending on the reported <event> value and it may be related to a specific LwM2M server (e.g. <event>=1). According to the <event> parameter value a URC can be issued:
  • <event>=0 (bootstrap status): for each phase of the factory bootstrap procedure
  • <event>=1 (registration status): when a LwM2M server changes the state of its registration
  • <event>=2 (remaining time until the next registration update): to periodically show the remaining time (in seconds) before the next registration update towards each LwM2M server
  • <event>=3 (notification): when a LwM2M notification is sent from the LwM2M client to the LwM2M server during a valid observation
  • <event>=4 (LwM2M client status): when the overall state of the LwM2M client changes
  • <event>=5 (LwM2M client initialization status): for each phase of the initialization of the LwM2M client
  • <event>=6 (LwM2M server connection status): when a connection with a LwM2M server starts/stops/pauses/resumes

LEXI-R10401D-00B Syntax

TypeSyntaxResponseExample
Set
AT+ULWM2MSTAT=<n>[,<verbosity_mask>]
OK
AT+ULWM2MSTAT=1,1
OK
Read
AT+ULWM2MSTAT?
+ULWM2MSTAT: <n>,<verbosity_mask>
OK
+ULWM2MSTAT: 1,1
OK
Test
AT+ULWM2MSTAT=?
+ULWM2MSTAT: (list of supported <n>s),(list of supported <verbosity_mask>s)
OK
+ULWM2MSTAT: (0,1),(1-7)
OK
Generic syntax
URC
+ULWM2MSTAT: <event>,<param1>[,<param2>[,<param3>[,<param4>]]]
+ULWM2MSTAT: 1,721,2
Bootstrap status
URC
+ULWM2MSTAT: 0,<server_id>,<status>
+ULWM2MSTAT: 0,721,2
Registration status
URC
+ULWM2MSTAT: 1,<server_id>,<status>
+ULWM2MSTAT: 1,721,2
Registration interval
URC
+ULWM2MSTAT: 2,<server_id>,<reg_update_timer>
+ULWM2MSTAT: 2,721,10
Notification
URC
+ULWM2MSTAT: 3,<server_id>,<URI>
+ULWM2MSTAT: 3,123,"/3300/0/5700"
LwM2M client status
URC
+ULWM2MSTAT: 4,<client_status>
+ULWM2MSTAT: 4,7
LwM2M client initialization status
URC
+ULWM2MSTAT: 5,<client_init_status>
+ULWM2MSTAT: 5,1
LwM2M server connection status generic syntax
URC
+ULWM2MSTAT: 6,<server_id>,<server_connection_status>,<param3>[,<param4>]
+ULWM2MSTAT: 6,721,0,"leshan.eclipseprojects.io:5684"
LwM2M server connection created
URC
+ULWM2MSTAT: 6,<server_id>,0,<server_address>
+ULWM2MSTAT: 6,721,0,"leshan.eclipseprojects.io:5684"
LwM2M server connection suspended
URC
+ULWM2MSTAT: 6,<server_id>,1,<sent_data>,<received_data>
+ULWM2MSTAT: 6,721,1,1254,4588
LwM2M server connection resumed
URC
+ULWM2MSTAT: 6,<server_id>,2,<server_address>
+ULWM2MSTAT: 6,721,2,"leshan.eclipseprojects.io:5684"
LwM2M server connection closed
URC
+ULWM2MSTAT: 6,<server_id>,3,<sent_data>,<received_data>
+ULWM2MSTAT: 6,721,3,2365,5699

LEXI-R10401D-00B Defined values

ParameterTypeDescription
<n>
Number
Enables and disables the +ULWM2MSTAT URC:
  • 0: LwM2M status URC disabled
  • 1: LwM2M status +ULWM2MSTAT URC enabled
The factory-programmed value is:
  • LEXI-R10401D-00B - 0
<verbosity_mask>
Number
Optional parameter, represents a bitmask. It enables different levels of verbosity in +ULWM2MSTAT URC:
  • bit 0: enables reporting of <event>s from 0 to 4
  • bit 1: enables reporting of <event>: 5
  • bit 2: enables reporting of <event>: 6
The factory-programmed value is 1 (only bit 0 enabled)
<event>
Number
Event type:
  • 0: bootstrap status
  • 1: registration status
  • 2: remaining time until the next registration update
  • 3: notification. A notify message has been triggered as per Lightweight Machine to Machine Technical Specification [OMA-TS-LightweightM2M-V1_0-20170208-A]
  • 4: LwM2M client status
  • 5: LwM2M client initialization status
  • 6: LwM2M server connection status
Allowed values:
  • LEXI-R10401D-00B - 0, 1, 2, 3, 4, 5, 6
<server_id>
Number
Short server ID corresponding to a server defined by object 1 resource 0.
<status>
Number
Status code corresponding to the server state.
  • LEXI-R10401D-00B
    • 0: deregistered
    • 1: registration hold
    • 2: registration pending
    • 3: registration success
    • 4: registration failed
    • 5: registration update pending
    • 6: registration update needed
    • 7: registration full update needed
    • 8: deregistration needed
    • 9: deregistration pending
    • 10: bootstrap hold off
    • 11: bootstrap initiated
    • 12: bootstrap pending
    • 13: bootstrap finishing
    • 14: bootstrap finished
    • 15: bootstrap failing
    • 16: bootstrap failed
    • 19: bootstrap retrying
    Allowed values:
    • LEXI-R10401D-00B - 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19
<reg_update_timer>
Number
Time in seconds until the next registration update.
<URI>
String
Uniform Resource Identifier (URI) to existing object
<client_status>
Number
LwM2M client status:
  • 0: initial
  • 1: bootstrap required
  • 2: bootstrapping
  • 3: registration required
  • 4: registering
  • 5: ready
  • 6: command mode only. No server communication occurs.
  • 7: client shut down
Allowed values:
  • LEXI-R10401D-00B - 7
<client_init_status>
Number
LwM2M client initialization status:
  • 1: initialization started
  • 2: initialization finished
  • 3: client start aborted due to production mode
  • 4: initialization failed
Allowed values:
  • LEXI-R10401D-00B - 1, 2, 4
<server_connection_status>
Number
LwM2M server connection status:
  • 0: connection created; <param3> is the <server_address>
  • 1: connection idle; <param3> is <sent_data> and <param4> is the <received_data>
  • 2: connection restored; <param3> is the <server_address>
  • 3: connection closed; <param3> is <sent_data> and <param4> is the <received_data>
Allowed values:
  • LEXI-R10401D-00B - 0, 3
<server_address>
String
LwM2M server address, corresponding to the resource 0 of the Security Object, in the format "host:port".
<sent_data>
Number
Amount of data sent (at the CoAP level) to the LwM2M server so far on this logical connection.
<received_data>
Number
Amount of data received (at the CoAP level) from the LwM2M server so far on this logical connection.
<param1>
Number
The content depends on the related <event> (details are given above).
<param2>
String
Content and type depend on the related <event> (details are given above).
<param3>
Number or String
The content depends on the related <event> (details are given above).
<param4>
Number
The content depends on the related <event> (details are given above).

Notes

LEXI-R10401D-00B
  • The <sent_data>, <received_data> parameters are not supported.

Activate/deactivate LwM2M client +ULWM2M

+ULWM2M
Modules
LEXI-R10401D
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
Yes
NVM
No
-
+CME Error

LEXI-R10401D-00B Description

Activates or deactivates the LwM2M client.
After issuing the AT+ULWM2M=1 (stop the LwM2M client) command or the AT+ULWM2M=2 (reset the LwM2M client) command, the LwM2M features and the FOTA updates are not available.
The AT+ULWM2M=2 command erases the LwM2M object database; it has no effect on the NVM settings regarding LwM2M activation/deactivation.
LEXI-R10401D-00B
  • The AT+ULWM2M=1 command disables permanently the LwM2M client and is immediately effective (a module reboot is not required). The <activation_mode> parameter is saved in NVM and the LwM2M client will not start at subsequent module reboots. The AT+ULWM2M=0 command enables permanently the LwM2M client and is effective after a module reboot (e.g. by AT+CFUN=16). The <activation_mode> parameter is saved in NVM and the LwM2M client will start at subsequent module reboots.
  • The AT+ULWM2M=3 command inhibits temporarily the LwM2M client network activity towards all enabled servers and is immediately effective (a module reboot is not required). The <activation_mode> parameter is not saved in NVM and the LwM2M client will perform the normal network activity towards all enabled servers at subsequent module reboots. The AT+ULWM2M=0 command restores the LwM2M client normal network activity towards all enabled servers and is immediately effective (a module reboot is not required).
  • The AT+ULWM2M=2 command immediately stops and resets the LwM2M client (erases LwM2M object database, stored PSK and LwM2M client internal status). The <activation_mode> parameter is not saved in NVM and the LwM2M client will behave according the current value of <activation_mode> parameter saved in NVM.
  • The specific LwM2M servers can be enabled and disabled by the means of AT+ULWM2MCONFIG command.

LEXI-R10401D-00B Syntax

TypeSyntaxResponseExample
Set
AT+ULWM2M=<activation_mode>[,<nvm_saved>]
OK
AT+ULWM2M=1
OK
Read
AT+ULWM2M?
+ULWM2M: <activation_mode>
OK
+ULWM2M: 1
OK
Test
AT+ULWM2M=?
+ULWM2M: (list of supported <activation_mode>s),(list of supported <nvm_saved>s)
OK
+ULWM2M: (0-2),(0-1)
OK

LEXI-R10401D-00B Defined values

ParameterTypeDescription
<activation_mode>
Number
Operation type:
  • 0: enables the LwM2M client or restores the LwM2M client communication
  • 1: stops and disables the LwM2M client
  • 2: reset the LwM2M client (erases the LwM2M object database)
  • 3: communication with enabled servers inhibited
  • 4: communication with enabled servers permitted
Allowed values:
  • LEXI-R10401D-00B - 0, 1 (factory-programmed value), 2, 3. The factory-programmed value is 0 in Verizon mode (<MNO>=3; see the +UMNOPROF AT command).
<nvm_saved>
Number
Enables/disables the storing of <activation_mode>=1 configuration in the NVM. Allowed values:
  • 0 (default value): do not store the <activation_mode>=1 configuration in the NVM
  • 1: store the <activation_mode>=1 configuration in the NVM

Initiate LwM2M server registration +ULWM2MREG

+ULWM2MREG
Modules
LEXI-R10401D
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
No
No / OP
No
65
+CME Error

Description

Forces the bootstrap or the registration for a specific LwM2M server.

Syntax

TypeSyntaxResponseExample
Set
AT+ULWM2MREG=<server_id>
OK
AT+ULWM2MREG=123
OK
Read
AT+ULWM2MREG?
+ULWM2MREG: <server_id>,<server_status>[,<registration_interval>]
OK
+ULWM2MREG: 721,2,175
OK
Test
AT+ULWM2MREG=?
+ULWM2MREG: (0, list of supported <server_id>s)
OK
+ULWM2MREG: (0,721,123)
OK

Defined values

ParameterTypeDescription
<server_id>
Number
Short server ID corresponding to a server defined by object 1 resource 0. The special value 0 forces the client to perform the bootstrap process. Allowed values:
  • LEXI-R10401D-00B - The special value 0 is not supported.
<server_status>
Number
Status code corresponding to the server state.
  • LEXI-R10401D-00B
    • 0: deregistered
    • 1: registration hold
    • 2: registration pending
    • 3: registration success
    • 4: registration failed
    • 5: registration update pending
    • 6: registration update needed
    • 7: registration full update needed
    • 8: deregistration needed
    • 9: deregistration pending
    • 10: bootstrap hold off
    • 11: bootstrap initiated
    • 12: bootstrap pending
    • 13: bootstrap finishing
    • 14: bootstrap finished
    • 15: bootstrap failing
    • 16: bootstrap failed
    • 19: bootstrap retrying
    Allowed values:
    • LEXI-R10401D-00B - - 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19
<registration_interval>
Number
For successfully registered servers (see the <server_status> parameter) this is the number of seconds until the next registration update

Notes

LEXI-R10401D-00B
  • The set command, when invoked with the parameter <server_id> corresponding to a specific short server ID, returns immediately the "OK" final result code. The LwM2M registration procedure to the specific target server is scheduled and executed later. The registration is confirmed by +ULWM2MSTAT URC, where the <reg_update_timer> parameter is expected to restart after a successful server registration.

LwM2M server configuration +ULWM2MCONFIG

+ULWM2MCONFIG
Modules
LEXI-R10401D
Attributes
Syntax
PIN required
Settings saved
Can be aborted
Response time
Error reference
full
No
No / OP
No
-
+CME Error

Description

Configures connection parameters for a LwM2M server. It can be used to edit existing configurations or to define configurations for additional servers. This command allows specifying parameters used during a server connection and LwM2M client behavior in case of a registration failure.
The information text response to the read command provides the configuration of LwM2M servers connection parameters in separate rows.
Allowed values of <server_id> depends on the selected mobile network operator profile (for more details, see the +UMNOPROF AT command). For the list of available servers in each mobile network operator profile, refer to the +ULWM2MREG AT command row of the proper mobile network operator table in Mobile network operator profiles.

Syntax

TypeSyntaxResponseExample
Set
AT+ULWM2MCONFIG=
<server_id>,
<bootstrap_on_failure>,
<pdn_ip_type>,
<cid>,
<usec_psk>,
<reg_update_boot>,
<dtls_session_resumption>,
<full_registration_after_fota>,
<DTLS_NAT_timer>,
<reg_upd_at_PSM_exit>,
<reg_upd_after_DTLS_handshake>,
<server_disabled>
OK
AT+ULWM2MCONFIG=721,0,2,1,1,0,0,0,40,0,0,0
OK
Read
AT+ULWM2MCONFIG?
+ULWM2MCONFIG: <server_id>,
<bootstrap_on_failure>,
<pdn_ip_type>,
<cid>,
<usec_psk>,
<reg_update_boot>,
<dtls_session_resumption>,
<full_registration_after_fota>,
<DTLS_NAT_timer>,
<reg_upd_at_PSM_exit>,
<reg_upd_after_DTLS_handshake>,
<server_disabled>
[…​]
OK
+ULWM2MCONFIG: 721,0,2,1,1,0,0,0,40,0,0,0
+ULWM2MCONFIG: 123,0,1,1,0,0,0,0,40,0,0,0
OK
Test
AT+ULWM2MCONFIG=?
+ULWM2MCONFIG:
(list of supported <server_id>s),
(list of supported <bootstrap_on_failure>s),
(list of supported <pdn_ip_type>s),
(list of supported <cid>s),
(list of supported <usec_psk>s),
(list of supported <reg_update_boot>s),
(list of supported <dtls_session_resumption>s),
(list of supported <full_registration_after_fota>s),
(list of supported <DTLS_NAT_timer>s),
(list of supported <reg_upd_at_PSM_exit>s),
(list of supported <reg_upd_after_DTLS_handshake>s),
(list of supported <server_disabled>s)
OK
+ULWM2MCONFIG: (1-65535),(0-1),(1-3),(1-8),(0-1),(0-1),(0-1),(0-1),(0-86400),(0-1),(0-2),(0-2)
OK

Defined values

ParameterTypeDescription
<server_id>
Number
Short server ID corresponding to a server defined by object 1 resource 0
<bootstrap_on_failure>
Number
Enable/disable a bootstrap attempt after a failed registration. Allowed values:
  • 0: disable a bootstrap attempt after a failed registration
  • 1: enable a bootstrap attempt after a failed registration
<pdn_ip_type>
Number
Packet data network (PDN) type. Allowed values:
  • 1: IPv4
  • 2: IPv6
  • 3: IPv4v6
<cid>
Number
See <cid>.
<usec_psk>
Number
Use the pre-shared key (PSK) generated by the root of trust. Allowed values:
  • 0: disabled
  • 1: enabled
For more details on data and device security features, see Data and device security.
<reg_update_boot>
Number
Force a registration update with the LwM2M server after a reboot. Allowed values:
  • 0: disabled
  • 1: enabled
<dtls_session_resumption>
Number
Enable the DTLS session resumption. For more details, see RFC 7925 [65]. Allowed values:
  • 0: disabled
  • 1: enabled
<full_registration_after_fota>
Number
Force a full registration with the LwM2M server after a FOTA has been performed. Allowed values:
  • 0: disabled
  • 1: enabled
<DTLS_NAT_timer>
Number
Timeout (in seconds) representing the network address translation (NAT) timer for LwM2M DTLS session re-handshake. Timer is restarted after any LwM2M packet is sent or received; if it times out, the next delivery will cause a DTLS handshake. The range goes from 0 to 86400.
<reg_upd_at_PSM_exit>
Number
Force a full registration with the LwM2M server when module turns ON as a result of PSM exit. Allowed values:
  • 0: disabled
  • 1: enabled
<reg_upd_after_DTLS_handshake>
Number
Force a registration update in the case a new DTLS handshake is performed. Allowed values:
  • 0: always disabled
  • 1: always enabled
  • 2: enabled only during FOTA
<server_disabled>
Number
When disabled, LwM2M client communication to the server is prevented: it will not perform registration updates and no data to the server will be sent.
  • 0: always enabled
  • 1: always disabled
  • 2: disabled only in roaming cell condition
Allowed values:
  • LEXI-R10401D-00B - 0, 1
For the list of default enabled servers in each mobile network operator profile, see the "LwM2M capabilities" row of the proper mobile network operator table in Mobile network operator profiles.

Notes

LEXI-R10401D-00B
  • The <bootstrap_on_failure>,<pdn_ip_type>,<cid>,<usec_psk>,<reg_update_boot>,<dtls_session_resumption>,<full_registration_after_fota>,<DTLS_NAT_timer>,<reg_upd_at_PSM_exit> and <reg_upd_after_DTLS_handshake> parameters are not effective.
  • These settings are stored into an internal file and are not persistent if the MNO profile is changed via the +UMNOPROF AT command.
Last updated: 13 January 2025
Need help?Contact Support
Questions?Contact us