michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Update LwM2M documentation

Browse source 
Update the documentation according to API changes.

Signed-off-by: Jarno Lämsä <jarno.lamsa@nordicsemi.no>
This commit is contained in:
Jarno Lämsä 2023-01-05 13:32:32 +02:00 • committed by Carles Cufí
commit 28bb34dc6d
2 changed files with 20 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

34
doc/connectivity/networking/api/lwm2m.rst
View file

@ -331,29 +331,29 @@ to connect as well as set the ``Manufacturer`` and ``Reboot`` resources in the
* Server URL of default Security object = 0/0/0 * Server URL of default Security object = 0/0/0
* Use leshan.eclipse.org server IP (5.39.83.206) for connection * Use leshan.eclipse.org server IP (5.39.83.206) for connection
*/ */
lwm2m_engine_set_string("0/0/0", "coap://5.39.83.206"); lwm2m_set_string(&LWM2M_OBJ(0, 0, 0), "coap://5.39.83.206");
/* /*
* Security Mode of default Security object = 0/0/2 * Security Mode of default Security object = 0/0/2
* 3 = NoSec mode (no security beware!) * 3 = NoSec mode (no security beware!)
*/ */
lwm2m_engine_set_u8("0/0/2", 3); lwm2m_set_u8(&LWM2M_OBJ(0, 0, 2), 3);
#define CLIENT_MANUFACTURER "Zephyr Manufacturer" #define CLIENT_MANUFACTURER "Zephyr Manufacturer"
/* /*
* Manufacturer resource of Device object = 3/0/0 * Manufacturer resource of Device object = 3/0/0
* We use lwm2m_engine_set_res_data() function to set a pointer to the * We use lwm2m_set_res_data() function to set a pointer to the
* CLIENT_MANUFACTURER string. * CLIENT_MANUFACTURER string.
* Note the LWM2M_RES_DATA_FLAG_RO flag which stops the engine from * Note the LWM2M_RES_DATA_FLAG_RO flag which stops the engine from
* trying to assign a new value to the buffer. * trying to assign a new value to the buffer.
*/ */
lwm2m_engine_set_res_data("3/0/0", CLIENT_MANUFACTURER, lwm2m_set_res_data(&LWM2M_OBJ(3, 0, 0), CLIENT_MANUFACTURER,
sizeof(CLIENT_MANUFACTURER), sizeof(CLIENT_MANUFACTURER),
LWM2M_RES_DATA_FLAG_RO); LWM2M_RES_DATA_FLAG_RO);
/* Reboot resource of Device object = 3/0/4 */ /* Reboot resource of Device object = 3/0/4 */
lwm2m_engine_register_exec_callback("3/0/4", device_reboot_cb); lwm2m_register_exec_callback(&LWM2M_OBJ(3, 0, 4), device_reboot_cb);
Lastly, we start the LwM2M RD client (which in turn starts the LwM2M engine). Lastly, we start the LwM2M RD client (which in turn starts the LwM2M engine).
The second parameter of :c:func:`lwm2m_rd_client_start` is the client The second parameter of :c:func:`lwm2m_rd_client_start` is the client
@ -391,13 +391,13 @@ resource. Lastly, set the client identity and PSK resources.
.. code-block:: c .. code-block:: c
/* Use coaps:// for server URL protocol */ /* Use coaps:// for server URL protocol */
lwm2m_engine_set_string("0/0/0", "coaps://5.39.83.206"); lwm2m_set_string(&LWM2M_OBJ(0, 0, 0), "coaps://5.39.83.206");
/* 0 = Pre-Shared Key mode */ /* 0 = Pre-Shared Key mode */
lwm2m_engine_set_u8("0/0/2", 0); lwm2m_set_u8(&LWM2M_OBJ(0, 0, 2), 0);
/* Set the client identity */ /* Set the client identity */
lwm2m_engine_set_string("0/0/3", (char *)client_identity); lwm2m_set_string(&LWM2M_OBJ(0, 0, 3), (char *)client_identity);
/* Set the client pre-shared key (PSK) */ /* Set the client pre-shared key (PSK) */
lwm2m_engine_set_opaque("0/0/5", (void *)client_psk, sizeof(client_psk)); lwm2m_set_opaque(&LWM2M_OBJ(0, 0, 5), (void *)client_psk, sizeof(client_psk));
Before calling :c:func:`lwm2m_rd_client_start` assign the tls_tag # where the Before calling :c:func:`lwm2m_rd_client_start` assign the tls_tag # where the
LwM2M library should store the DTLS information prior to connection (normally a LwM2M library should store the DTLS information prior to connection (normally a
@ -413,16 +413,16 @@ For a more detailed LwM2M client sample see: :ref:`lwm2m-client-sample`.
Multi-thread usage Multi-thread usage
****************** ******************
Writing a value to a resource can be done using functions like lwm2m_engine_set_u8. When writing Writing a value to a resource can be done using functions like lwm2m_set_u8. When writing
to multiple resources, the function lwm2m_registry_lock will ensure that the to multiple resources, the function lwm2m_registry_lock will ensure that the
client halts until all writing operations are finished: client halts until all writing operations are finished:
.. code-block:: c .. code-block:: c
lwm2m_registry_lock(); lwm2m_registry_lock();
lwm2m_engine_set_u32("1/0/1", 60); lwm2m_set_u32(&LWM2M_OBJ(1, 0, 1), 60);
lwm2m_engine_set_u8("5/0/3", 0); lwm2m_set_u8(&LWM2M_OBJ(5, 0, 3), 0);
lwm2m_engine_set_float("3303/0/5700", &value); lwm2m_set_f64(&LWM2M_OBJ(3303, 0, 5700), value);
lwm2m_registry_unlock(); lwm2m_registry_unlock();
This is especially useful if the server is composite-observing the resources being This is especially useful if the server is composite-observing the resources being
@ -478,9 +478,9 @@ Read and Write operations
Full content of data cache is written into a payload when any READ, SEND or NOTIFY operation Full content of data cache is written into a payload when any READ, SEND or NOTIFY operation
internally reads the content of a given resource. This has a side effect that any read callbacks internally reads the content of a given resource. This has a side effect that any read callbacks
registered for a that resource are ignored when cache is enabled. registered for a that resource are ignored when cache is enabled.
Data is written into a cache when any of the ``lwm2m_engine_set_*`` functions are called. To filter Data is written into a cache when any of the ``lwm2m_set_*`` functions are called. To filter
the data entering the cache, application may register a validation callback using the data entering the cache, application may register a validation callback using
:c:func:`lwm2m_engine_register_validate_callback`. :c:func:`lwm2m_register_validate_callback`.
Limitations Limitations
=========== ===========

3
doc/releases/release-notes-3.3.rst
View file

@ -199,6 +199,9 @@ Deprecated in this release
* SPI DT :c:func:`spi_is_ready` function has been deprecated in favor of :c:func:`spi_is_ready_dt`. * SPI DT :c:func:`spi_is_ready` function has been deprecated in favor of :c:func:`spi_is_ready_dt`.
* LwM2M APIs using string references as LwM2M paths has been deprecated in favor of functions
using :c:struct:`lwm2m_path_obj` instead.
Stable API changes in this release Stable API changes in this release
================================== ==================================