net: lwm2m: Add new API to set multiple resource values #68988
Conversation
zephyrbot
added
Release Notes
zephyrbot
requested review from
henrikbrixandersen,
jukkar,
kartben,
MaureenHelm,
nashif,
rlubos,
SeppoTakalo,
ssharks and
tbursztyka
doc/releases/release-notes-3.6.rst
Outdated
| @@ -577,6 +577,10 @@ Networking | |||
|
|
|||
| * LwM2M: | |||
|
|
|||
| * Added new API function to set multiple resource values: | |||
There was a problem hiding this comment.
I'm afraid this won't make it to 3.6, will need to move this entry to 3.7 release notes, once available.
There was a problem hiding this comment.
OK. Removed the change note entry for now.
| int lwm2m_set_bulk(const struct lwm2m_res_item res_list[], size_t res_list_size) | ||
| { | ||
| int ret; | ||
| for (int i = 0; i < res_list_size; i++) { |
There was a problem hiding this comment.
Wouldn't it make sense to take the registry lock before iterating? That way we could set several resources in an "atomic" way.
There was a problem hiding this comment.
Good point. Added registry lock
juhaylinen
force-pushed
the
lwm2m_set_bulk
branch
2 times, most recently
from
5428957
to
eca2377
Compare
juhaylinen
changed the title
There was a problem hiding this comment.
After an internal discussion, we realized that this needs special handling for strings.
When target type is string or opaque, the length must be different. See lwm2m_set_string().
I have no idea how to detect from the API that the given pointer points to string. So it should be properly documented.
There was a problem hiding this comment.
After a second thought, I don't think we can detect the proper use of strings, so it should be documented.
There is no type in the struct lwm2m_res_item so it is impossible to know if the developer is doing the right thing when writing to opaque resources.
At least current lwm2m_set_string() API allows writing strings to opaque resources, for example PSK ID is sometimes written like this. This should be allowed.
include/zephyr/net/lwm2m.h
Outdated
| struct lwm2m_res_item { | ||
| struct lwm2m_obj_path *path; /**< Pointer to LwM2M path as a struct */ | ||
| void *value; /**< Pointer to resource value */ | ||
| uint16_t len; /**< Length of value */ |
There was a problem hiding this comment.
| uint16_t len; /**< Length of value */ | |
| uint16_t size; /**< Size of the value. For string resources, it should contain the null-terminator. */ |
include/zephyr/net/lwm2m.h
Outdated
| * @brief Set multiple resource (instance) values | ||
| * | ||
| * @param[in] res_list LwM2M resource item list | ||
| * @param[in] res_list_size Length of resource list | ||
| * | ||
| * @return 0 for success or negative in case of error. | ||
| */ |
There was a problem hiding this comment.
| * @brief Set multiple resource (instance) values | |
| * | |
| * @param[in] res_list LwM2M resource item list | |
| * @param[in] res_list_size Length of resource list | |
| * | |
| * @return 0 for success or negative in case of error. | |
| */ | |
| * @brief Set multiple resource (instance) values | |
| * | |
| * When writing strings to opaque resources, the null-terminator should not be counted in the size field. | |
| * When writing strings to string resources, the null-terminator should be included in the size. | |
| * | |
| * @param[in] res_list LwM2M resource item list | |
| * @param[in] res_list_size Length of resource list | |
| * | |
| * @return 0 for success or negative in case of error. | |
| */ |
juhaylinen
force-pushed
the
lwm2m_set_bulk
branch
2 times, most recently
from
f118101
to
ed4f77b
Compare
juhaylinen
force-pushed
the
lwm2m_set_bulk
branch
from
ed4f77b
to
3057ec2
Compare
henrikbrixandersen
added
Release Notes Required
Add new API lwm2m_set_bulk() to set multiple resource values in one function call. Signed-off-by: Juha Ylinen <juha.ylinen@nordicsemi.no>
Add an example how to set multiple resource values using lwm2m_set_bulk() function. Signed-off-by: Juha Ylinen <juha.ylinen@nordicsemi.no>
Add test case for lwm2m_set_bulk() function. Signed-off-by: Juha Ylinen <juha.ylinen@nordicsemi.no>
Add new API function lwm2m_set_bulk. Signed-off-by: Juha Ylinen <juha.ylinen@nordicsemi.no>
juhaylinen
force-pushed
the
lwm2m_set_bulk
branch
from
3057ec2
to
7000880
Compare
|
Added entry to 3.7 release notes. |
Add new API lwm2m_set_bulk() to set multiple resource values in one function call.
Update lwm2m sample and add test case.
Add entry to release notes.