sol-lwm2m.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#pragma once

#include <stdbool.h>
#include <stdint.h>
#include <stdarg.h>
#include <string.h>

#include "sol-coap.h"
#include "sol-network.h"
#include "sol-str-slice.h"
#include "sol-vector.h"
#include "sol-buffer.h"
#include "sol-types.h"

#ifdef __cplusplus
extern "C" {
#endif

#define SOL_LWM2M_DEFAULT_SERVER_PORT_COAP (5683)

#define SOL_LWM2M_DEFAULT_SERVER_PORT_DTLS (5684)

struct sol_lwm2m_client_object;
typedef struct sol_lwm2m_client_object sol_lwm2m_client_object;

enum sol_lwm2m_binding_mode {
    SOL_LWM2M_BINDING_MODE_U,
    SOL_LWM2M_BINDING_MODE_UQ,
    SOL_LWM2M_BINDING_MODE_S,
    SOL_LWM2M_BINDING_MODE_SQ,
    SOL_LWM2M_BINDING_MODE_US,
    SOL_LWM2M_BINDING_MODE_UQS,
    SOL_LWM2M_BINDING_MODE_UNKNOWN = -1,
};

enum sol_lwm2m_security_mode {
    SOL_LWM2M_SECURITY_MODE_PRE_SHARED_KEY = 0,
    SOL_LWM2M_SECURITY_MODE_RAW_PUBLIC_KEY = 1,
    SOL_LWM2M_SECURITY_MODE_CERTIFICATE = 2,
    SOL_LWM2M_SECURITY_MODE_NO_SEC = 3
};

enum sol_lwm2m_content_type {
    SOL_LWM2M_CONTENT_TYPE_TEXT = 1541,
    SOL_LWM2M_CONTENT_TYPE_OPAQUE = 1544,
    SOL_LWM2M_CONTENT_TYPE_TLV = 1542,
    SOL_LWM2M_CONTENT_TYPE_JSON = 1543
};

enum sol_lwm2m_tlv_type {
    SOL_LWM2M_TLV_TYPE_OBJECT_INSTANCE = 0,
    SOL_LWM2M_TLV_TYPE_RESOURCE_INSTANCE = 64,
    SOL_LWM2M_TLV_TYPE_MULTIPLE_RESOURCES = 128,
    SOL_LWM2M_TLV_TYPE_RESOURCE_WITH_VALUE = 192
};

enum sol_lwm2m_resource_data_type {
    SOL_LWM2M_RESOURCE_DATA_TYPE_STRING,
    SOL_LWM2M_RESOURCE_DATA_TYPE_INT,
    SOL_LWM2M_RESOURCE_DATA_TYPE_FLOAT,
    SOL_LWM2M_RESOURCE_DATA_TYPE_BOOL,
    SOL_LWM2M_RESOURCE_DATA_TYPE_OPAQUE,
    SOL_LWM2M_RESOURCE_DATA_TYPE_TIME,
    SOL_LWM2M_RESOURCE_DATA_TYPE_OBJ_LINK,
    SOL_LWM2M_RESOURCE_DATA_TYPE_NONE = -1
};

enum sol_lwm2m_resource_type {
    SOL_LWM2M_RESOURCE_TYPE_SINGLE,
    SOL_LWM2M_RESOURCE_TYPE_MULTIPLE,
    SOL_LWM2M_RESOURCE_TYPE_UNKNOWN = -1
};

typedef struct sol_lwm2m_security_psk {
    struct sol_blob *id;
    struct sol_blob *key;
} sol_lwm2m_security_psk;

typedef struct sol_lwm2m_security_rpk {
    struct sol_blob *private_key;
    struct sol_blob *public_key;
} sol_lwm2m_security_rpk;

typedef struct sol_lwm2m_tlv {
#ifndef SOL_NO_API_VERSION
#define SOL_LWM2M_TLV_API_VERSION (1)

    uint16_t api_version;
#endif

    enum sol_lwm2m_tlv_type type;
    uint16_t id;
    struct sol_buffer content;
} sol_lwm2m_tlv;

typedef struct sol_lwm2m_resource {
#ifndef SOL_NO_API_VERSION
#define SOL_LWM2M_RESOURCE_API_VERSION (1)

    uint16_t api_version;
#endif

    enum sol_lwm2m_resource_type type;
    enum sol_lwm2m_resource_data_type data_type;
    uint16_t id;
    uint16_t data_len;
    struct sol_lwm2m_resource_data {
        uint16_t id;
        union {
            struct sol_blob *blob;
            int64_t integer;
            double fp;
            bool b;
        } content;
    } *data;
} sol_lwm2m_resource;

enum sol_lwm2m_acl_rights {
    SOL_LWM2M_ACL_NONE = 0,
    SOL_LWM2M_ACL_READ = 1,
    SOL_LWM2M_ACL_WRITE = 2,
    SOL_LWM2M_ACL_EXECUTE = 4,
    SOL_LWM2M_ACL_DELETE = 8,
    SOL_LWM2M_ACL_CREATE = 16,
    SOL_LWM2M_ACL_ALL = 31
};

#define SOL_LWM2M_RESOURCE_INIT(ret_value_, resource_, id_, type_, resource_len_, data_type_, ...) \
    do { \
        SOL_SET_API_VERSION((resource_)->api_version = SOL_LWM2M_RESOURCE_API_VERSION; ) \
        (ret_value_) = sol_lwm2m_resource_init((resource_), (id_), (type_), (resource_len_), (data_type_), __VA_ARGS__); \
    } while (0)

#define SOL_LWM2M_RESOURCE_SINGLE_INIT(ret_value_, resource_, id_, data_type_, value_) \
    do { \
        SOL_SET_API_VERSION((resource_)->api_version = SOL_LWM2M_RESOURCE_API_VERSION; ) \
        (ret_value_) = sol_lwm2m_resource_init((resource_), (id_), SOL_LWM2M_RESOURCE_TYPE_SINGLE, 1, (data_type_), value_); \
    } while (0)

#define SOL_LWM2M_RESOURCE_SINGLE_INT_INIT(ret_value_, resource_, id_, value_) \
    do { \
        SOL_SET_API_VERSION((resource_)->api_version = SOL_LWM2M_RESOURCE_API_VERSION; ) \
        (ret_value_) = sol_lwm2m_resource_init((resource_), (id_), SOL_LWM2M_RESOURCE_TYPE_SINGLE, 1, SOL_LWM2M_RESOURCE_DATA_TYPE_INT, SOL_TYPE_CHECK(int64_t, (value_))); \
    } while (0)

typedef struct sol_lwm2m_payload {
    enum sol_lwm2m_content_type type;
    union sol_lwm2m_payload_data {
        struct sol_vector tlv_content;
        struct sol_str_slice slice_content;
    } payload ;
} sol_lwm2m_payload;

void sol_lwm2m_resource_clear(struct sol_lwm2m_resource *resource);

int sol_lwm2m_resource_init(struct sol_lwm2m_resource *resource,
    uint16_t id, enum sol_lwm2m_resource_type type, uint16_t resource_len,
    enum sol_lwm2m_resource_data_type data_type, ...);

int sol_lwm2m_resource_init_vector(struct sol_lwm2m_resource *resource,
    uint16_t id, enum sol_lwm2m_resource_data_type data_type,
    struct sol_vector *res_instances);

int sol_lwm2m_parse_tlv(const struct sol_str_slice content, struct sol_vector *tlv_values);

void sol_lwm2m_tlv_list_clear(struct sol_vector *tlvs);

void sol_lwm2m_tlv_clear(struct sol_lwm2m_tlv *tlv);

int sol_lwm2m_tlv_get_float(struct sol_lwm2m_tlv *tlv, double *value);

int sol_lwm2m_tlv_get_bool(struct sol_lwm2m_tlv *tlv, bool *value);

int sol_lwm2m_tlv_get_int(struct sol_lwm2m_tlv *tlv, int64_t *value);

int sol_lwm2m_tlv_get_bytes(struct sol_lwm2m_tlv *tlv, struct sol_buffer *buf);

int sol_lwm2m_tlv_get_obj_link(struct sol_lwm2m_tlv *tlv, uint16_t *object_id, uint16_t *instance_id);

int sol_lwm2m_client_object_get_id(const struct sol_lwm2m_client_object *object, uint16_t *id);

const struct sol_ptr_vector *sol_lwm2m_client_object_get_instances(const struct sol_lwm2m_client_object *object);

#ifdef __cplusplus
}
#endif