RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

pkg/wakaama: add functions to interact with resources

Browse Source
This commit is contained in:
Leandro Lanzieri 2021-03-12 18:41:52 +01:00
parent bfc81ae967
commit e0896afddc
No known key found for this signature in database
GPG Key ID: F4E9A721761C7593
3 changed files with 1000 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pkg/wakaama/contrib/objects/Makefile
View File

@ -1,5 +1,7 @@
MODULE := wakaama_objects
SRC += common.c
SUBMODULES = 1
include $(RIOTBASE)/Makefile.base

448
pkg/wakaama/contrib/objects/common.c Normal file
View File

@ -0,0 +1,448 @@
/*
* Copyright (C) 2021 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @{
* @ingroup lwm2m_objects_common
*
* @file
* @brief Common functionalities to interact with LwM2M objects
*
* @author Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
* @}
*/
#include "liblwm2m.h"
#include "lwm2m_client.h"
#include "objects/common.h"
#define ENABLE_DEBUG 0
#include "debug.h"
/**
* @brief Auxiliary structure to hold pointers that form an object link data type.
*/
typedef struct {
uint16_t *object_id; /**< pointer to object ID */
uint16_t *instance_id; /**< pointer to instance ID */
} _objlink_t;
/**
* @brief Get data of a given type from an object's instance.
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[in] expected_type Type of data that is expected from the specified resource.
* @param[out] out Pointer where to store the data.
* @param[in] out_len Length of @p out.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
* @retval -ENOTSUP when the resource expected type is not known
*/
static int _get_resource_data(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri,
lwm2m_data_type_t expected_type, void *out, size_t out_len)
{
assert(client_data);
assert(uri);
assert(out);
int result = 0;
int data_num = 1;
lwm2m_data_t *data = NULL;
/* try to find the requested object */
lwm2m_object_t *object = lwm2m_get_object_by_id(client_data, uri->objectId);
if (!object || !object->readFunc) {
DEBUG("[lwm2m:get_data] could not find object with ID %d\n", uri->objectId);
result = -ENOENT;
goto out;
}
/* prepare a new data structure */
data = lwm2m_data_new(1);
if (!data) {
DEBUG("[lwm2m:get_data] could not allocate data structure\n");
result = -ENOMEM;
goto out;
}
data->id = uri->resourceId;
/* read the resource from the specified instance */
uint8_t res = object->readFunc(uri->instanceId, &data_num, &data, object);
if (res != COAP_205_CONTENT || data->type != expected_type) {
result = -EINVAL;
goto out;
}
/* process the data according to the type */
switch (expected_type) {
case LWM2M_TYPE_INTEGER:
*(int64_t *)out = data->value.asInteger;
break;
case LWM2M_TYPE_FLOAT:
*(double *)out = data->value.asFloat;
break;
case LWM2M_TYPE_BOOLEAN:
*(bool *)out = data->value.asBoolean;
break;
case LWM2M_TYPE_OBJECT_LINK:
{
_objlink_t *_out = (_objlink_t *)out;
*_out->object_id = data->value.asObjLink.objectId;
*_out->instance_id = data->value.asObjLink.objectInstanceId;
break;
}
case LWM2M_TYPE_STRING:
case LWM2M_TYPE_OPAQUE:
if (data->value.asBuffer.length > out_len) {
DEBUG("[lwm2m:get_data] not enough space in buffer\n");
result = -ENOMEM;
}
else {
memcpy(out, data->value.asBuffer.buffer, data->value.asBuffer.length);
}
break;
default:
DEBUG("[lwm2m:get_data] not supported type\n");
result = -ENOTSUP;
break;
}
out:
if (data) {
lwm2m_data_free(1, data);
}
return result;
}
/**
* @brief Get the value of a resource, specified by a path @p path.
*
* Convenience function to call @ref _get_resource_data with a string representing the resource's
* path.
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[in] expected_type Type of data that is expected from the specified resource.
* @param[out] out Pointer where to store the data.
* @param[in] out_len Length of @p out.
*
* @retval 0 on success
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
*/
static int _get_resource_data_by_path(lwm2m_client_data_t *client_data, const char *path,
size_t path_len, lwm2m_data_type_t expected_type, void *out,
size_t out_len)
{
assert(path);
lwm2m_uri_t uri;
if (!lwm2m_stringToUri(path, path_len, &uri)) {
DEBUG("[lwm2m:get_resource] malformed path\n");
return -EINVAL;
}
return _get_resource_data(client_data, &uri, expected_type, out, out_len);
}
/**
* @brief Set data of a given type to an object's instance.
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] type Type of data of the specified resource.
* @param[in] in Pointer to the data to set.
* @param[in] in_len Length of @p in.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -ENOTSUP when the resource type is not known
* @retval -EINVAL when the value can not be set
*/
static int _set_resource_data(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri,
lwm2m_data_type_t type, void *in, size_t in_len)
{
assert(client_data);
assert(uri);
assert(in);
int result = 0;
lwm2m_data_t *data = NULL;
/* try to find the requested object */
lwm2m_object_t *object = lwm2m_get_object_by_id(client_data, uri->objectId);
if (!object || !object->writeFunc) {
DEBUG("[lwm2m:get_data] could not find object with ID %d\n", uri->objectId);
result = -ENOENT;
goto out;
}
/* prepare a new data structure */
data = lwm2m_data_new(1);
if (!data) {
DEBUG("[lwm2m:set_data] could not allocate data structure\n");
result = -ENOMEM;
goto out;
}
data->id = uri->resourceId;
data->type = type;
/* prepare the data according to the type */
switch (type) {
case LWM2M_TYPE_INTEGER:
data->value.asInteger = *(int64_t *)in;
break;
case LWM2M_TYPE_FLOAT:
data->value.asFloat = *(double *)in;
break;
case LWM2M_TYPE_BOOLEAN:
data->value.asBoolean = *(bool *)in;
break;
case LWM2M_TYPE_OBJECT_LINK:
{
_objlink_t *_in = (_objlink_t *)in;
data->value.asObjLink.objectId = *_in->object_id;
data->value.asObjLink.objectInstanceId = *_in->instance_id;
break;
}
case LWM2M_TYPE_STRING:
case LWM2M_TYPE_OPAQUE:
data->value.asBuffer.length = in_len;
data->value.asBuffer.buffer = in;
break;
default:
DEBUG("[lwm2m:get_data] not supported type\n");
result = -ENOTSUP;
goto out;
break;
}
/* write the resource of the specified instance */
uint8_t res = object->writeFunc(uri->instanceId, 1, data, object);
if (res != COAP_204_CHANGED) {
result = -EINVAL;
}
out:
if (data) {
/* NOTE: lwm2m_data_free will try to free strings and opaques if set, assuming they were
allocated, so empty the pointer first */
if (type == LWM2M_TYPE_STRING || type == LWM2M_TYPE_OPAQUE) {
data->value.asBuffer.buffer = NULL;
}
lwm2m_data_free(1, data);
}
return result;
}
/**
* @brief Set the value of a string-type resource, specified by a path @p path.
*
* Convenience function to call @ref _set_resource_data with a string representing the resource's
* path.
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[in] expected_type Type of data that is expected from the specified resource.
* @param[in] in Pointer where to store the data.
* @param[in] in_len Length of @p out.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOTSUP when the resource type is not known
* @retval -ENOMEM when data structure can not be allocated
*/
static int _set_resource_data_by_path(lwm2m_client_data_t *client_data, const char *path,
size_t path_len, lwm2m_data_type_t type, void *in,
size_t in_len)
{
assert(path);
lwm2m_uri_t uri;
if (!lwm2m_stringToUri(path, path_len, &uri)) {
DEBUG("[lwm2m:set_resource] malformed path\n");
return -EINVAL;
}
return _set_resource_data(client_data, &uri, type, in, in_len);
}
int lwm2m_get_string(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, char *out,
size_t out_len)
{
return _get_resource_data(client_data, uri, LWM2M_TYPE_STRING, out, out_len);
}
int lwm2m_get_opaque(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, uint8_t *out,
size_t out_len)
{
return _get_resource_data(client_data, uri, LWM2M_TYPE_OPAQUE, out, out_len);
}
int lwm2m_get_int(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, int64_t *out)
{
return _get_resource_data(client_data, uri, LWM2M_TYPE_INTEGER, out, sizeof(int64_t));
}
int lwm2m_get_float(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, double *out)
{
return _get_resource_data(client_data, uri, LWM2M_TYPE_FLOAT, out, sizeof(double));
}
int lwm2m_get_bool(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, bool *out)
{
return _get_resource_data(client_data, uri, LWM2M_TYPE_BOOLEAN, out, sizeof(bool));
}
int lwm2m_get_objlink(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri,
uint16_t *object_id_out, uint16_t *instance_id_out)
{
assert(object_id_out);
assert(instance_id_out);
_objlink_t link = { .object_id = object_id_out, .instance_id = instance_id_out };
return _get_resource_data(client_data, uri, LWM2M_TYPE_OBJECT_LINK, &link, sizeof(_objlink_t));
}
int lwm2m_get_string_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
char *out, size_t out_len)
{
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_STRING, out, out_len);
}
int lwm2m_get_opaque_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint8_t *out, size_t out_len)
{
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_OPAQUE, out, out_len);
}
int lwm2m_get_int_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
int64_t *out)
{
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_INTEGER, out,
sizeof(int64_t));
}
int lwm2m_get_float_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
double *out)
{
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_FLOAT, out,
sizeof(double));
}
int lwm2m_get_bool_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
bool *out)
{
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_BOOLEAN, out,
sizeof(bool));
}
int lwm2m_get_objlink_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint16_t *object_id_out, uint16_t *instance_id_out)
{
assert(object_id_out);
assert(instance_id_out);
_objlink_t link = { .object_id = object_id_out, .instance_id = instance_id_out };
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_OBJECT_LINK, &link,
sizeof(_objlink_t));
}
int lwm2m_set_string(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, char *val,
size_t val_len)
{
return _set_resource_data(client_data, uri, LWM2M_TYPE_STRING, val, val_len);
}
int lwm2m_set_opaque(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, uint8_t *val,
size_t val_len)
{
return _set_resource_data(client_data, uri, LWM2M_TYPE_OPAQUE, val, val_len);
}
int lwm2m_set_int(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, int64_t val)
{
return _set_resource_data(client_data, uri, LWM2M_TYPE_INTEGER, &val, sizeof(int64_t));
}
int lwm2m_set_float(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, double val)
{
return _set_resource_data(client_data, uri, LWM2M_TYPE_FLOAT, &val, sizeof(double));
}
int lwm2m_set_bool(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, bool val)
{
return _set_resource_data(client_data, uri, LWM2M_TYPE_BOOLEAN, &val, sizeof(bool));
}
int lwm2m_set_objlink(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri,
uint16_t object_id_in, uint16_t instance_id_in)
{
_objlink_t link = { .object_id = &object_id_in, .instance_id = &instance_id_in };
return _set_resource_data(client_data, uri, LWM2M_TYPE_OBJECT_LINK, &link, sizeof(_objlink_t));
}
int lwm2m_set_string_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
char *val, size_t val_len)
{
return _set_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_STRING, val, val_len);
}
int lwm2m_set_opaque_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint8_t *val, size_t val_len)
{
return _set_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_OPAQUE, val, val_len);
}
int lwm2m_set_int_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
int64_t val)
{
return _set_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_INTEGER, &val,
sizeof(int64_t));
}
int lwm2m_set_float_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
double val)
{
return _set_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_FLOAT, &val,
sizeof(double));
}
int lwm2m_set_bool_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
bool val)
{
return _set_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_BOOLEAN, &val,
sizeof(bool));
}
int lwm2m_set_objlink_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint16_t object_id_in, uint16_t instance_id_in)
{
_objlink_t link = { .object_id = &object_id_in, .instance_id = &instance_id_in };
return _get_resource_data_by_path(client_data, path, path_len, LWM2M_TYPE_OBJECT_LINK, &link,
sizeof(_objlink_t));
}

550
pkg/wakaama/include/objects/common.h Normal file
View File

@ -0,0 +1,550 @@
/*
* Copyright (C) 2021 HAW Hamburg
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup pkg_wakaama
* @defgroup lwm2m_objects_common Common LwM2M Object functionalities
* @brief Common functionalities to interact with LwM2M objects
* @{
*
* @file
*
* @author Leandro Lanzieri <leandro.lanzieri@haw-hamburg.de>
*/
#ifndef OBJECTS_COMMON_H
#define OBJECTS_COMMON_H
#ifdef __cplusplus
extern "C" {
#endif
#include "liblwm2m.h"
#include "lwm2m_client.h"
/**
* @brief Get the handle for an object type of the client by its ID.
*
* @note This is not a single instance of a given object, but the object type
* representation.
*
* @param[in] client_data Pointer to the client data
* @param[in] id ID of the object to get
*
* @return Pointer to the object type
*/
static inline lwm2m_object_t *lwm2m_get_object_by_id(lwm2m_client_data_t *client_data, uint16_t id)
{
return (lwm2m_object_t *)LWM2M_LIST_FIND(client_data->lwm2m_ctx->objectList, id);
}
/**
* @brief Get the value of a string-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[out] out Buffer to place the resource in. Must not be NULL.
* @param[in] out_len Available space in @p out.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
*/
int lwm2m_get_string(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, char *out,
size_t out_len);
/**
* @brief Get the value of a string-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_get_string with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[out] out Buffer to place the resource in. Must not be NULL.
* @param[in] out_len Available space in @p out.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
*/
int lwm2m_get_string_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
char *out, size_t out_len);
/**
* @brief Get the value of an opaque-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[out] out Buffer to place the resource in. Must not be NULL.
* @param[in] out_len Available space in @p out.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
*/
int lwm2m_get_opaque(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, uint8_t *out,
size_t out_len);
/**
* @brief Get the value of an opaque-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_get_opaque with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[out] out Buffer to place the resource in. Must not be NULL.
* @param[in] out_len Available space in @p out.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
*/
int lwm2m_get_opaque_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint8_t *out, size_t out_len);
/**
* @brief Get the value of an integer-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[out] out Pointer where to place the value.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
*/
int lwm2m_get_int(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, int64_t *out);
/**
* @brief Get the value of an integer-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_get_int with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[out] out Pointer where to place the value.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
*/
int lwm2m_get_int_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
int64_t *out);
/**
* @brief Get the value of an float-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[out] out Pointer where to place the value.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
*/
int lwm2m_get_float(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, double *out);
/**
* @brief Get the value of an float-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_get_float with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[out] out Pointer where to place the value.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
*/
int lwm2m_get_float_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
double *out);
/**
* @brief Get the value of an boolean-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[out] out Pointer where to place the value.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
*/
int lwm2m_get_bool(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, bool *out);
/**
* @brief Get the value of an float-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_get_bool with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[out] out Pointer where to place the value.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
*/
int lwm2m_get_bool_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
bool *out);
/**
* @brief Get the value of an objectlink-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (object_id_out != NULL) &&
* (instance_id_out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to get.
* @param[out] object_id_out Pointer where to place the object ID.
* @param[out] instance_id_out Pointer where to place the instance ID.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the resource cannot be read or has an unexpected type
*/
int lwm2m_get_objlink(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri,
uint16_t *object_id_out, uint16_t *instance_id_out);
/**
* @brief Get the value of an objectlink-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_get_objlink with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (object_id_out != NULL) &&
* (instance_id_out != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to get.
* @param[in] path_len Length of @p path.
* @param[out] object_id_out Pointer where to place the object ID.
* @param[out] instance_id_out Pointer where to place the instance ID.
*
* @retval 0 on success
* @retval -ENOMEM when there is not enough space in buffer or can not allocate a data structure
* @retval -ENOENT when the resource is not found
* @retval -EINVAL if the path is malformed, the resource cannot be read or has an unexpected type
*/
int lwm2m_get_objlink_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint16_t *object_id_out, uint16_t *instance_id_out);
/**
* @brief Set the value of a string-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (val != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] val Buffer with the value to set. Must not be NULL.
* @param[in] val_len Length of @p val.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the value can not be set
*/
int lwm2m_set_string(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, char *val,
size_t val_len);
/**
* @brief Set the value of a string-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_set_string with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (val != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to set.
* @param[in] path_len Length of @p path.
* @param[in] val Buffer with the value to set. Must not be NULL.
* @param[in] val_len Length of @p val.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOMEM when data structure can not be allocated
*/
int lwm2m_set_string_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
char *val, size_t val_len);
/**
* @brief Set the value of an opaque-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL) && (val != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] val Buffer with the value to set. Must not be NULL.
* @param[in] val_len Length of @p val.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the value can not be set
*/
int lwm2m_set_opaque(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, uint8_t *val,
size_t val_len);
/**
* @brief Set the value of an opaque-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_set_opaque with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL) && (val != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to set.
* @param[in] path_len Length of @p path.
* @param[in] val Buffer with the value to set. Must not be NULL.
* @param[in] val_len Length of @p val.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOMEM when data structure can not be allocated
*/
int lwm2m_set_opaque_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint8_t *val, size_t val_len);
/**
* @brief Set the value of an integer-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] val Value to set.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the value can not be set
*/
int lwm2m_set_int(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, int64_t val);
/**
* @brief Set the value of an integer-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_set_int with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to set.
* @param[in] path_len Length of @p path.
* @param[in] val Value to set.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOMEM when data structure can not be allocated
*/
int lwm2m_set_int_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
int64_t val);
/**
* @brief Set the value of an float-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] val Value to set.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the value can not be set
*/
int lwm2m_set_float(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, double val);
/**
* @brief Set the value of an float-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_set_float with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to set.
* @param[in] path_len Length of @p path.
* @param[in] val Value to set.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOMEM when data structure can not be allocated
*/
int lwm2m_set_float_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
double val);
/**
* @brief Set the value of an boolean-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] val Value to set.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the value can not be set
*/
int lwm2m_set_bool(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri, bool val);
/**
* @brief Set the value of an float-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_set_bool with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to set.
* @param[in] path_len Length of @p path.
* @param[in] val Value to set.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOMEM when data structure can not be allocated
*/
int lwm2m_set_bool_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
bool val);
/**
* @brief Set the value of an objectlink-type resource, specified by @p uri.
*
* @pre `(client_data != NULL) && (uri != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] uri Initialized URI structure specifying the resource to set.
* @param[in] object_id_in Object ID value to set.
* @param[in] instance_id_in Instance ID value to set.
*
* @retval 0 on success
* @retval -ENOMEM when data structure can not be allocated
* @retval -ENOENT when the resource is not found
* @retval -EINVAL when the value can not be set
*/
int lwm2m_set_objlink(lwm2m_client_data_t *client_data, const lwm2m_uri_t *uri,
uint16_t object_id_in, uint16_t instance_id_in);
/**
* @brief Set the value of an objectlink-type resource, specified by a path @p path.
*
* Convenience function to call @ref lwm2m_set_objlink with a string representing the resource's
* path.
*
* @pre `(client_data != NULL) && (path != NULL)`
*
* @param[in] client_data Pointer to the LwM2M client data.
* @param[in] path Array containing the path to the resource to set.
* @param[in] path_len Length of @p path.
* @param[in] object_id_in Object ID value to set.
* @param[in] instance_id_in Instance ID value to set.
*
* @retval 0 on success
* @retval -EINVAL when the path is malformed, the value can not be set
* @retval -ENOENT when the resource is not found
* @retval -ENOMEM when data structure can not be allocated
*/
int lwm2m_set_objlink_by_path(lwm2m_client_data_t *client_data, const char *path, size_t path_len,
uint16_t object_id_in, uint16_t instance_id_in);
#ifdef DOXYGEN
/**
* @name URI representation
* @brief Note that these are defined in `liblwm2m.h`.
* @{
*/
/**
* @brief Flag to indicate in @ref lwm2m_uri_t::flag that the object ID is present.
*/
#define LWM2M_URI_FLAG_OBJECT_ID (uint8_t)0x04
/**
* @brief Flag to indicate in @ref lwm2m_uri_t::flag that the instance ID is present.
*/
#define LWM2M_URI_FLAG_INSTANCE_ID (uint8_t)0x02
/**
* @brief Flag to indicate in @ref lwm2m_uri_t::flag that the resource ID is present.
*/
#define LWM2M_URI_FLAG_RESOURCE_ID (uint8_t)0x01
/**
* @brief Representation of an URI in a LwM2M client (defined in `liblwm2m.h`).
*/
typedef struct {
uint8_t flag; /**< indicates which segments are present */
uint16_t objectId; /**< object ID */
uint16_t instanceId; /**< instance ID */
uint16_t resourceId; /**< resource ID */
} lwm2m_uri_t;
/** @} */
#endif /* DOXYGEN */
#ifdef __cplusplus
}
#endif
#endif /* OBJECTS_COMMON_H */
/** @} */