API Defined by LWM2M

Updated on 2022-02-24 GMT+08:00

View PDF

Overview

The LWM2M Enabler consists of two components: LWM2M Server and LWM2M Client. LWM2M designs the following four types of APIs for the interaction between the two components:

API for device discovery and registration
Bootstrap API
API for device management and service enablement
Information reporting API

API Model

The following figure shows an API model defined by LWM2M.

Figure 1 API model defined by LWM2M
click to enlarge

Message Interaction Process

The following figure shows the message interaction process defined by LWM2M.

Figure 2 Message interaction process defined by LWM2M
click to enlarge

API for Device Management and Service Enablement

Each type of LWM2M APIs represents a type of functions. The API for device management and service implementation is one of the four types of APIs defined by LWM2M.

The functions of the four types of APIs are implemented by the following two operations:

Upstream operation: LWM2M Client –> LWM2M Server
Downstream operation: LWM2M Server –> LWM2M Client

LWM2M Server accesses object instances and resources of the LWM2M Client through the API for device management and service enablement. This API implements seven operations including create, read, write, delete, execute, write attributes, and discover.

Figure 3 Operations implemented by the API for device management and service enablement
click to enlarge

API	Operation	Direction
Device management and service enablement	Create, read, write, delete, execute, write attributes, and discover	Downstream

The following figure shows the interaction process implemented by the API for device management and service enablement.

Figure 4 Interaction process implemented by the API for device management and service enablement
click to enlarge

Figure 5 Creating and deleting an object
click to enlarge

Parent topic: Appendix 1 LWM2M

Previous topic: Resource Defined by LWM2M

Next topic: Firmware Upgrade

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot