Jump to content

RUTM51 LwM2M Client

From Teltonika Networks Wiki
Main Page > RUTM Routers > RUTM51 > RUTM51 Manual > RUTM51 WebUI > RUTM51 Services section > RUTM51 LwM2M Client


LwM2M Client

The LwM2M Client page is used to configure the device as an LwM2M client and manage connections to bootstrap and management servers.

Note: LwM2M Client is additional software that can be installed from the System → Package Manager page.

Status


The Status section displays information about the current LwM2M Client state.

Field Value Description
State - Displays the current state of the LwM2M Client.
Endpoint string Displays the endpoint name used to identify the device to LwM2M servers.

General settings


The General settings section is used to enable the LwM2M Client service and configure general client parameters.

Field Value Description
Enabled off | on; default: off Enables or disables the LwM2M Client service.
Endpoint Name string; default: none Endpoint Client Name used to identify the device to LwM2M servers. If left empty, the private enterprise number and the device's serial number are used.
Bootstrap Interval integer [1..86400]; default: 60 Number of seconds to wait before retrying bootstrap after a failed bootstrap attempt.

Bootstrap servers


The Bootstrap servers section is used to configure LwM2M bootstrap server instances.

A bootstrap server is used to provision or modify LwM2M Client configuration according to the bootstrap server configuration. This can include management server configuration and credentials. The client attempts to start the bootstrap process when no valid management server configuration is available. Configuration changes are applied to the device only after a successful Bootstrap Finish.

Note: Multiple bootstrap server instances can be configured, but only the first configured bootstrap server is used.

To create a new bootstrap server instance, click the Add button. You will be redirected to the bootstrap server instance configuration page:

Field Value Description
Enabled off | on; default: off Enables or disables the LwM2M bootstrap server instance.
Name string; Name of the LwM2M bootstrap server instance.
URI URL; default: none LwM2M server URI. The URI scheme determines the transport protocol:
  • coap - uses UDP. If no port is specified, port 5683 is used.
  • coaps - uses DTLS over UDP. If no port is specified, port 5684 is used.

Examples: coap://192.168.1.100, coaps://lwm2m.example.com:5684.

Security No security | DTLS Pre-Shared Key; default: No security Security mode used for communication with the server:
  • No security - communication is neither encrypted nor authenticated.
  • DTLS Pre-Shared Key - uses DTLS with a pre-shared key to provide encrypted communication and mutual authentication.
PSK Identity string; default: none Identity string used for DTLS Pre-Shared Key authentication. Used to identify the client to the server. Max length is 128 characters.
Pre-Shared Key hex string; default: none Pre-Shared Key in hexadecimal format used for DTLS communication. The same key must be configured on both the client and server. Max length is 64 characters.

After a successful bootstrap process, the client applies the configuration received from the bootstrap server and connects to the provisioned management server. The bootstrap server does not remain as the active management connection.

The figure below shows an example of a successfully bootstrapped LwM2M Client:

Management servers


The Management servers section is used to configure LwM2M management server instances and their associated security instances.

A management server is used for regular LwM2M communication after the client has been provisioned. It can read supported device information, change supported settings, execute operations, receive notifications, and manage firmware updates.

To create a new management server instance, click the Add button.

You will be redirected to the management server configuration page:

Field Value Description
Enabled off | on; default: off Enables or disables the LwM2M server instance.
Name string Name of the LwM2M server instance.
Lifetime integer [10..86400]; default: 3600 Lifetime of the registration in seconds. If left empty, the registration lifetime is infinite.
Queue mode off | on; default: off Enables or disables Queue mode. When enabled, the client connects to the server only when it needs to send a notification or update its registration. When disabled, the client keeps the connection to the server open.

Click the Next: Security configuration button to configure security settings for the management server.

A management server can have multiple security instances*. To create an additional security instance, click + Add new security.

* Note: Multiple security instances can be configured for the same management server. If more than one is configured, only the first security instance with a compatible URI scheme is used; the remaining instances are ignored.

Field Value Description
Enabled off | on; default: off Enables or disables the LwM2M security instance.
Name string Name of the LwM2M security instance.
URI URL; default: none LwM2M server URI. The URI scheme determines the transport protocol:
  • coap - uses UDP. If no port is specified, port 5683 is used.
  • coaps - uses DTLS over UDP. If no port is specified, port 5684 is used.

Examples: coap://192.168.1.100, coaps://lwm2m.example.com:5684.

Security No security | DTLS Pre-Shared Key; default: No security Security mode used for communication with the server:
  • No security - communication is neither encrypted nor authenticated.
  • DTLS Pre-Shared Key - uses DTLS with a pre-shared key to provide encrypted communication and mutual authentication.
PSK Identity string; default: none Identity string used for DTLS Pre-Shared Key authentication. Used to identify the client to the server. Max length is 128 characters.
Pre-Shared Key hexadecimal; default: none Pre-Shared Key in hexadecimal format used for DTLS communication. The same key must be configured on both the client and server. Max length is 64 characters.

Implemented objects


RutOS implements LwM2M 1.1 and supports the objects listed below. Individual LwM2M objects may have their own object versions defined by OMA SpecWorks.

The tables below list the LwM2M objects and resources, together with their IDs, implemented on the RUTM51 device. Detailed object and resource definitions, including data types, value ranges and object versions, are publicly available in the official LwM2M Registry.

Object ID Object
0 Security
1 Server
2 Access Control
3 Device
4 Connectivity Monitoring
5 Firmware Update
7 Connectivity Statistics
11 APN Connection Profile
3200 Digital Input
3201 Digital Output

The following operation types are used in the resource tables below:

  • R - Read
  • W - Write
  • E - Execute

Obj. ID 0 - Security


Resource ID Name Operations
0 URI RW
1 Bootstrap Server RW
2 Security Mode RW
3 Public Key RW
5 Secret Key RW
10 Short Server ID RW
11 Client Hold Off Time RW

Notes:

  • The Security object is not visible to management servers.
  • It can only be configured through WebUI/UCI or by a bootstrap server.

Obj. ID 1 - Server


Resource ID Name Operations
0 Short Server ID R
1 Lifetime RW
6 Notification storing when disabled or Offline RW
7 Binding RW
8 Registration Update Trigger E
16 Bootstrap on Registration Failure RW
17 Communication Retry Count RW
18 Communication Retry Timer RW
19 Communication Sequence Delay Timer RW
20 Communication Sequence Retry Count RW
23 Mute Send RW

Notes:

  • Changing Lifetime or Binding causes the client to send a registration update to the server.
  • If Queue mode was previously enabled, the client cannot explicitly indicate that Queue mode has been disabled in a registration update due to a limitation in the LwM2M specification.

Obj. ID 2 - Access Control


Resource ID Name Operations
0 Object ID R
1 Object Instance ID R
2 ACL RW
3 Access Control Owner R

Notes:

  • Only bootstrap servers can create or delete Access Control instances.
  • Access Control is considered enabled if at least one Access Control instance exists.
  • When Access Control is enabled, creating a new object instance also creates a corresponding Access Control instance.
  • Deleting an object instance also deletes the related Access Control instance, if one exists.

Obj. ID 3 - Device


Resource ID Name Operations
0 Manufacturer R
1 Model Number R
2 Serial Number R
3 Firmware Version R
4 Reboot E
10 Memory Free R
11 Error Code R
13 Current Time RW
14 UTC Offset R
15 Timezone RW
16 Supported Binding and Modes R
18 Hardware Version R
21 Memory Total R

Notes:

  • Error Code always returns a single instance with value 0, indicating no error.
  • UTC Offset is read-only. Changing the UTC offset directly is not supported because it can interfere with RutOS timezone configuration.

Obj. ID 4 - Connectivity Monitoring


Resource ID Name Operations
0 Network Bearer R
1 Available Network Bearer R
2 Radio Signal Strength R
4 IP Addresses R
8 Cell ID R
9 SMNC R
10 SMCC R
11 SignalSNR R

Notes:

  • If the current network bearer is not mobile, Radio Signal Strength, Cell ID, SMNC, SMCC and SignalSNR return 404 Not Found.

Obj. ID 5 - Firmware Update


Resource ID Name Operations
0 Package RW
1 Package URI RW
2 Update E
3 State R
5 Update Result R
8 Firmware Update Protocol Support R
9 Firmware Update Delivery Method R

Notes:

  • Package and Package URI accept regular RutOS firmware images.
  • CoAP push and HTTP(S) pull firmware update methods are supported.
  • CoAP push is slower than HTTP(S) pull, but is supported for compatibility.
  • Only firmware images compatible with the Keep settings option are accepted. This prevents the device from becoming unreachable through LwM2M after a firmware update.
  • HTTP(S) firmware downloads use a 60 second stall timeout.


Obj. ID 7 - Connectivity Statistics


Resource ID Name Operations
2 Tx Data R
3 Rx Data R
6 Start E
7 Stop E

Notes:

  • Statistics are aggregated for all network interfaces except the loopback interface.

Obj. ID 11 - APN Connection Profile


Resource ID Name Operations
0 Profile name RW
1 APN RW
2 Auto Select APN by device RW
3 Enable status RW
4 Authentication type RW
5 User Name RW
6 Secret RW
13 TotalBytesSent R
14 TotalBytesReceived R
15 IP address R
19 Primary DNS address RW
24 PDN Type RW

Notes:

  • Each mobile WAN interface has its own APN Connection Profile object instance.
  • IP address is read-only.
  • Primary DNS address contains both primary and secondary DNS addresses because RutOS does not distinguish between primary and secondary DNS in this object.

Obj. ID 3200 - Digital Input


Resource ID Name Operations
5500 Digital Input State R
5502 Digital Input Polarity RW
5750 Application Type RW

Notes:

  • Application Type reads or writes the custom name of the I/O pin.
  • If no custom name is configured, the pin's default meta name is returned.
  • The same behavior applies to the other I/O objects.

Obj. ID 3201 - Digital Output


Resource ID Name Operations
5500 Digital Output State RW
5750 Application Type RW