LWM2M Application Programming Interface

Callback function upon requests on a given LWM2M resource instance.

Will be called when the request is for an instance Ex. /0/1.

If no instance could be located the object callback will be called. The instance_id corresponds to the one in the URI-patch in the CoAP request and may be used to create a new instance. If the value of resource_id is set to LWM2M_INVALID_RESOURCE the callback should treated it as a call to the instance instead of a resource inside of the instance.

If a resource has been found p_instance pointer will be set, else it will be NULL.

Parameters

[in]	p_instance	Pointer to the located resource if it already exists.
[in]	resource_id	Id of the resource requested.
[in]	op_code	Opcode of the request. Values of the opcodes are defined in Types .
[in]	p_request	Pointer to the CoAP request message.

Return values

NRF_SUCCESS

Will always return success.

Callback function upon request on a given LWM2M object or instance create.

Will be called when the request is for an object Ex: /0 or /0/1 an instance and the op_code is CREATE. Depending on the CoAP request code the user might create an instance or just return the tlv of current instances. If the value of instance_id is set to LWM2M_INVALID_INSTANCE the callback should treated it as a call to the instance instead of an instance of the object.

Parameters

[in]	p_object	Pointer to the located object.
[in]	instance_id	Id of the instance requested.
[in]	op_code	Opcode of the request. Values of the opcodes are defined in Types .
[in]	p_request	Pointer to the CoAP request message.

Return values

NRF_SUCCESS

Will always return success.

Send bootstrap request to a remote bootstrap server.

Sends a bootstrap request with specified ID to the specified remote, calls the lwm2m_notification with answer from the bootstrap server.

Parameters

[in]	p_remote	Pointer to the structure holding connection information of the remote LWM2M bootstrap server.
[in]	p_id	Pointer to the structure holding the Id of the client.
[in]	local_port	Port number of the local port to be used to send the bootstrap request.

Return values

NRF_SUCCESS	If bootstrap request to the LWM2M bootstrap server was sent successfully.
NRF_ERROR_NULL	If one of the parameters was a NULL pointer.

Generate link format string based on registered objects and instances.

Note

For generation of links to work properly it is required that objects is added before instances.

Parameters

[in,out]	p_buffer	Pointer to a buffer to fill with link format encoded string. If a NULL pointer is provided the function will dry-run the function in order to calculate how much memory that is needed for the link format string.
[in,out]	p_buffer_len	As input used to indicate the length of the buffer. It will return the used amount of buffer length by reference in response. If NULL pointer is provided for p_buffer, the value by reference output will be the number of bytes needed to generate the link format string.

Return values

NRF_SUCCESS	If generation of link format string was successful.
NRF_ERROR_NO_MEM	If the provided memory was not large enough.

Add an instance to coap_handler in order to match requests to the given instance.

Add a new LWM2M instance to the coap_handler. The application MUST initialize and allocate the additional data in the struct.

Parameters

[in]

p_instance

Pointer to the instance to add.

Return values

NRF_SUCCESS	If registration was successful.
NRF_ERROR_NO_MEM	If the module was not able to add the instance. Verify that the LWM2M_COAP_HANDLER_MAX_INSTANCES setting in sdk_config.h has a correct value.

Delete an instance from coap_handler in order to stop matching requests to the given instance.

Parameters

[in]

p_instance

Pointer to the instance to delete.

Return values

NRF_SUCCESS	If unregistration was a success.
NRF_ERROR_NOT_FOUND	If the given instance was not located.

Add an object to coap_handler in order to match requests to the given object.

Add a new LWM2M object to the coap_handler. The application MUST initialize and allocate the additional data in the struct.

Parameters

[in]

p_object

Pointer to the object to add.

Return values

NRF_SUCCESS	If registration was successful.
NRF_ERROR_NO_MEM	If the module was not able to add the object. Verify that the LWM2M_COAP_HANDLER_MAX_OBJECTS setting in sdk_config.h has a correct value.

Delete an object from coap_handler in order to stop matching requests to the given object.

Parameters

[in]

p_object

Pointer to the object to delete.

Return values

NRF_SUCCESS	If unregistration was a success.
NRF_ERROR_NOT_FOUND	If the given object was not located.

CoAP Request handler for the root of the object/instance/resource hierarchy.

The function is called when a request is for the lwm2m root (ie no object instance or resource).

Warning

This is an interface function. MUST BE IMPLEMENTED BY APPLICATION.

Parameters

[in]	op_code	LWM2M operation code.
[in]	p_request	Pointer to CoAP request message.

Return values

NRF_SUCCESS

If the handler processed the request successfully.

Deregister from a remote server.

Parameters

[in]	p_remote	Pointer to the structure holding connection information of the remote LWM2M server.
[in]	local_port	Port number of the local port to be used to send the deregister request.

Return values

NRF_SUCCESS

If deregister request to the LWM2M server was sent out successfully.

Initialize LWM2M library.

Return values

NRF_SUCCESS

If initialization was successful.

Callback interface from the enabler interface (bootstrap/register) to the application.

Warning

This is an interface function. MUST BE IMPLEMENTED BY APPLICATION.

Parameters

[in]	type	Notification type. The types are defined in lwm2m_notification_type_t .
[in]	p_remote	remote that answered the request
[in]	coap_code	coap op code from the response

Return values

NRF_SUCCESS

If the client application handled the notification successfully.

Register with a remote LWM2M server.

Parameters

[in]	p_remote	Pointer to the structure holding connection information of the remote LWM2M server.
[in]	p_id	Pointer to the structure holding the Id of the client.
[in]	p_config	Registration parameters.
[in]	local_port	Port number of the local port to be used to send the register request.
[in]	p_link_format_string	Pointer to a link format encoded string to send in the register request.
[in]	link_format_len	Length of the link format string provided.

Return values

NRF_SUCCESS

If registration request to the LWM2M server was sent out successfully.

Send CoAP response with a given CoAP message code.

Parameters

[in]	code	CoAP response code to send.
[in]	p_request	Original CoAP request. Must not be NULL.

Return values

NRF_SUCCESS

If the response was sent out successfully.

Send CoAP 2.05 Content response with the payload provided.

Parameters

[in]	p_payload	Pointer to the payload to send. Must not be NULL.
[in]	payload_len	Size of the payload.
[in]	p_request	Original CoAP request. Must not be NULL.

Return values

NRF_SUCCESS

If the response was sent out successfully.

Update a registration with a remote server.

Parameters

[in]	p_remote	Pointer to the structure holding connection information of the remote LWM2M server.
[in]	p_config	Registration parameters.
[in]	local_port	Port number of the local port to be used to send the update request.

Return values

NRF_SUCCESS

If update request to the LWM2M server was sent out successfully.