nrf_cloud_codec.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_CLOUD_CODEC_H__
#define NRF_CLOUD_CODEC_H__
 
#include <net/nrf_cloud.h>
#if defined(CONFIG_NRF_CLOUD_PGPS)
#include <net/nrf_cloud_pgps.h>
#endif
#if defined(CONFIG_NRF_MODEM)
#include <nrf_modem_gnss.h>
#endif /* CONFIG_NRF_MODEM */
#include <net/wifi_location_common.h>
#include <modem/lte_lc.h>
 
#include <cJSON.h>
#include <modem/lte_lc.h>
#include <net/wifi_location_common.h>
#include <net/nrf_cloud_location.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum nrf_cloud_obj_type {
        NRF_CLOUD_OBJ_TYPE__UNDEFINED,
 
        NRF_CLOUD_OBJ_TYPE_JSON,
        NRF_CLOUD_OBJ_TYPE_COAP_CBOR,
 
        NRF_CLOUD_OBJ_TYPE__LAST,
};
 
enum nrf_cloud_enc_src {
        NRF_CLOUD_ENC_SRC_NONE,
        NRF_CLOUD_ENC_SRC_CLOUD_ENCODED,
        NRF_CLOUD_ENC_SRC_PRE_ENCODED,
};
 
enum nrf_cloud_data_type {
        NRF_CLOUD_DATA_TYPE_NONE,
        NRF_CLOUD_DATA_TYPE_PVT,
        NRF_CLOUD_DATA_TYPE_STR,
        NRF_CLOUD_DATA_TYPE_DOUBLE,
        NRF_CLOUD_DATA_TYPE_INT
};
 
struct nrf_cloud_obj_coap_cbor {
        char *app_id;
        enum nrf_cloud_data_type type;
        union {
                char *str_val;
                struct nrf_cloud_gnss_pvt *pvt;
                double double_val;
                int int_val;
        };
        int64_t ts;
};
 
struct nrf_cloud_obj {
 
        enum nrf_cloud_obj_type type;
        union {
                cJSON *json;
                struct nrf_cloud_obj_coap_cbor *coap_cbor;
        };
 
        enum nrf_cloud_enc_src enc_src;
        struct nrf_cloud_data encoded_data;
};
 
enum nrf_cloud_obj_shadow_type {
        /* A shadow delta, when there is a mismatch between "desired" and "reported" sections. */
        NRF_CLOUD_OBJ_SHADOW_TYPE_DELTA,
        /* The accepted shadow data. nRF Cloud provides a trimmed report to reduce overhead. */
        NRF_CLOUD_OBJ_SHADOW_TYPE_ACCEPTED,
        /* The shadow data received in response to a JSONata transform request. */
        NRF_CLOUD_OBJ_SHADOW_TYPE_TF
};
 
struct nrf_cloud_obj_shadow_delta {
        int ver;
        int64_t ts;
        struct nrf_cloud_obj state;
};
 
struct nrf_cloud_obj_shadow_accepted {
        struct nrf_cloud_obj desired;
        struct nrf_cloud_obj reported;
        struct nrf_cloud_obj config;
};
 
struct nrf_cloud_obj_shadow_transform_result {
        struct nrf_cloud_obj obj;
};
 
struct nrf_cloud_obj_shadow_transform_error {
        int code;
        int pos;
        char *msg;
 
        struct nrf_cloud_obj err_obj;
};
 
 
struct nrf_cloud_obj_shadow_transform {
        bool is_err;
 
        union {
                struct nrf_cloud_obj_shadow_transform_result result;
                struct nrf_cloud_obj_shadow_transform_error error;
        };
};
 
struct nrf_cloud_obj_shadow_data {
        enum nrf_cloud_obj_shadow_type type;
        union {
                struct nrf_cloud_obj_shadow_accepted *accepted;
                struct nrf_cloud_obj_shadow_delta *delta;
                struct nrf_cloud_obj_shadow_transform *transform;
        };
};
 
#define NRF_CLOUD_OBJ_JSON_DEFINE(_name) \
        struct nrf_cloud_obj _name = { .type = NRF_CLOUD_OBJ_TYPE_JSON, .json = NULL, \
                                       .enc_src = NRF_CLOUD_ENC_SRC_NONE, \
                                       .encoded_data = { .ptr = NULL, .len = 0 } }
 
#define NRF_CLOUD_OBJ_COAP_CBOR_DEFINE(_name) \
        struct nrf_cloud_obj _name = { .type = NRF_CLOUD_OBJ_TYPE_COAP_CBOR, \
                                       .coap_cbor = NULL, \
                                       .enc_src = NRF_CLOUD_ENC_SRC_NONE, \
                                       .encoded_data = { .ptr = NULL, .len = 0 } }
 
#define NRF_CLOUD_OBJ_DEFINE(_name, _type) \
        struct nrf_cloud_obj _name = { 0 }; \
        _name.type = _type; \
        _name.enc_src = NRF_CLOUD_ENC_SRC_NONE;
 
#define NRF_CLOUD_OBJ_PRE_ENC_DEFINE(_name, _data, _len) \
        struct nrf_cloud_obj _name = { .type = NRF_CLOUD_OBJ_TYPE__UNDEFINED, \
                                       .enc_src = NRF_CLOUD_ENC_SRC_PRE_ENCODED, \
                                       .encoded_data = { .ptr = _data, .len = _len } }
 
#define NRF_CLOUD_OBJ_TYPE_VALID(_obj_ptr) \
        (bool)((_obj_ptr != NULL) && \
               (_obj_ptr->type > NRF_CLOUD_OBJ_TYPE__UNDEFINED) && \
               (_obj_ptr->type < NRF_CLOUD_OBJ_TYPE__LAST))
 
int nrf_cloud_obj_input_decode(struct nrf_cloud_obj *const obj,
                               const struct nrf_cloud_data *const input);
 
int nrf_cloud_obj_msg_check(const struct nrf_cloud_obj *const obj, const char *const app_id,
                            const char *const msg_type);
 
int nrf_cloud_obj_num_get(const struct nrf_cloud_obj *const obj, const char *const key,
                          double *num);
 
int nrf_cloud_obj_str_get(const struct nrf_cloud_obj *const obj, const char *const key,
                          char **str);
 
int nrf_cloud_obj_bool_get(const struct nrf_cloud_obj *const obj, const char *const key,
                           bool *val);
 
int nrf_cloud_obj_object_detach(struct nrf_cloud_obj *const obj, const char *const key,
                                struct nrf_cloud_obj *const obj_out);
 
int nrf_cloud_obj_msg_init(struct nrf_cloud_obj *const obj, const char *const app_id,
                           const char *const msg_type);
 
 
int nrf_cloud_obj_bulk_init(struct nrf_cloud_obj *const bulk);
 
int nrf_cloud_obj_init(struct nrf_cloud_obj *const obj);
 
int nrf_cloud_obj_reset(struct nrf_cloud_obj *const obj);
 
int nrf_cloud_obj_free(struct nrf_cloud_obj *const obj);
 
bool nrf_cloud_obj_bulk_check(struct nrf_cloud_obj *const obj);
 
int nrf_cloud_obj_bulk_add(struct nrf_cloud_obj *const bulk, struct nrf_cloud_obj *const obj);
 
int nrf_cloud_obj_ts_add(struct nrf_cloud_obj *const obj, const int64_t time_ms);
 
int nrf_cloud_obj_num_add(struct nrf_cloud_obj *const obj, const char *const key,
                          const double val, const bool data_child);
 
int nrf_cloud_obj_str_add(struct nrf_cloud_obj *const obj, const char *const key,
                          const char *const val, const bool data_child);
 
int nrf_cloud_obj_bool_add(struct nrf_cloud_obj *const obj, const char *const key,
                           const bool val, const bool data_child);
 
int nrf_cloud_obj_null_add(struct nrf_cloud_obj *const obj, const char *const key,
                           const bool data_child);
 
int nrf_cloud_obj_object_add(struct nrf_cloud_obj *const obj, const char *const key,
                             struct nrf_cloud_obj *const obj_to_add, const bool data_child);
 
int nrf_cloud_obj_int_array_add(struct nrf_cloud_obj *const obj, const char *const key,
                                const uint32_t ints[], const uint32_t ints_cnt,
                                const bool data_child);
 
int nrf_cloud_obj_str_array_add(struct nrf_cloud_obj *const obj, const char *const key,
                                const char *const strs[], const uint32_t strs_cnt,
                                const bool data_child);
 
int nrf_cloud_obj_cloud_encode(struct nrf_cloud_obj *const obj);
 
int nrf_cloud_obj_cloud_encoded_free(struct nrf_cloud_obj *const obj);
 
int nrf_cloud_obj_gnss_msg_create(struct nrf_cloud_obj *const obj,
                                  const struct nrf_cloud_gnss_data * const gnss);
 
int nrf_cloud_obj_location_request_create(struct nrf_cloud_obj *const obj,
                                          const struct lte_lc_cells_info *const cells_inf,
                                          const struct wifi_scan_info *const wifi_inf,
                                          const struct nrf_cloud_location_config *const config);
 
int nrf_cloud_obj_pvt_add(struct nrf_cloud_obj *const obj,
                          const struct nrf_cloud_gnss_pvt * const pvt);
 
#if defined(CONFIG_NRF_MODEM)
int nrf_cloud_obj_modem_pvt_add(struct nrf_cloud_obj *const obj,
                                const struct nrf_modem_gnss_pvt_data_frame * const mdm_pvt);
#endif /* CONFIG_NRF_MODEM */
 
#if defined(CONFIG_NRF_CLOUD_PGPS)
int nrf_cloud_obj_pgps_request_create(struct nrf_cloud_obj *const obj,
                                      const struct gps_pgps_request * const request);
#endif
 
int nrf_cloud_gnss_msg_json_encode(const struct nrf_cloud_gnss_data * const gnss,
                                   cJSON * const gnss_msg_obj);
 
int nrf_cloud_service_info_json_encode(const struct nrf_cloud_svc_info *const svc_inf,
                                       cJSON * const svc_inf_obj);
 
int nrf_cloud_modem_info_json_encode(const struct nrf_cloud_modem_info *const mod_inf,
                                     cJSON * const mod_inf_obj);
 
int nrf_cloud_error_msg_decode(const char * const buf,
                               const char * const app_id,
                               const char * const msg_type,
                               enum nrf_cloud_error * const err);
 
int nrf_cloud_obj_shadow_delta_response_encode(struct nrf_cloud_obj *const delta_state_obj,
                                               bool accept);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_CLOUD_CODEC_H__ */