nrf_cloud_coap.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_CLOUD_COAP_H_
#define NRF_CLOUD_COAP_H_
 
#if defined(CONFIG_NRF_CLOUD_AGNSS)
#include <net/nrf_cloud_agnss.h>
#else
/* Forward declaration so struct nrf_cloud_coap_agnss_request compiles
 * in CoAP-only configurations that do not enable A-GNSS.
 */
struct nrf_modem_gnss_agnss_data_frame;
#endif
#if defined(CONFIG_NRF_CLOUD_PGPS)
#include <net/nrf_cloud_pgps.h>
#else
/* Forward declarations so nrf_cloud_coap_pgps_url_get compiles without CONFIG_NRF_CLOUD_PGPS */
struct nrf_cloud_coap_pgps_request;
struct nrf_cloud_pgps_result;
#endif
#include <net/nrf_cloud_codec.h>
/* <zephyr/net/coap.h> is always available and provides
 * enum coap_content_format. <zephyr/net/coap_client.h> requires
 * CONFIG_COAP_CLIENT_* symbols that only exist when CoAP client is
 * enabled, so it is only pulled in when this library is built with
 * CoAP support.
 */
#include <zephyr/net/coap.h>
#if defined(CONFIG_NRF_CLOUD_COAP)
#include <zephyr/net/coap_client.h>
#else
/* Work around missing Kconfigs upstream in coap_client.h */
#define coap_client_response_cb_t void *
struct coap_client {};
struct coap_client_option {};
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum nrf_cloud_coap_agnss_req_type {
        NRF_CLOUD_COAP_AGNSS_REQ_ASSISTANCE,
        NRF_CLOUD_COAP_AGNSS_REQ_LOCATION,
        NRF_CLOUD_COAP_AGNSS_REQ_CUSTOM
};
 
struct nrf_cloud_coap_agnss_request {
        enum nrf_cloud_coap_agnss_req_type type;
        struct nrf_modem_gnss_agnss_data_frame *agnss_req;
        struct lte_lc_cells_info *net_info;
        bool filtered;
        uint8_t mask_angle;
};
 
struct nrf_cloud_coap_agnss_result {
        char *buf;
        size_t buf_sz;
        size_t agnss_sz;
};
 
struct nrf_cloud_coap_location_request {
        struct lte_lc_cells_info *cell_info;
        struct wifi_scan_info *wifi_info;
        const struct nrf_cloud_location_config *config;
};
 
/* Transport functions */
int nrf_cloud_coap_init(void);
 
int nrf_cloud_coap_connect(const char * const app_ver);
 
int nrf_cloud_coap_pause(void);
 
int nrf_cloud_coap_resume(void);
 
int nrf_cloud_coap_shadow_configured_info_update(const char * const app_ver);
 
int nrf_cloud_coap_shadow_network_info_update(void);
 
bool nrf_cloud_coap_keepopen_is_supported(void);
 
int nrf_cloud_coap_disconnect(void);
 
/* nRF Cloud service functions */
 
int nrf_cloud_coap_agnss_data_get(struct nrf_cloud_coap_agnss_request const *const request,
                                  struct nrf_cloud_coap_agnss_result *result);
 
int nrf_cloud_coap_pgps_url_get(struct nrf_cloud_coap_pgps_request const *const request,
                                 struct nrf_cloud_pgps_result *file_location);
 
int nrf_cloud_coap_sensor_send(const char *app_id, double value, int64_t ts_ms, bool confirmable);
 
int nrf_cloud_coap_message_send(const char *app_id, const char *message, bool json, int64_t ts_ms,
                                bool confirmable);
 
int nrf_cloud_coap_json_message_send(const char *message, bool bulk, bool confirmable);
 
int nrf_cloud_coap_location_send(const struct nrf_cloud_gnss_data * const gnss, bool confirmable);
 
int nrf_cloud_coap_location_get(struct nrf_cloud_coap_location_request const *const request,
                                struct nrf_cloud_location_result *const result);
 
int nrf_cloud_coap_fota_job_get(struct nrf_cloud_fota_job_info *const job);
 
void nrf_cloud_coap_fota_job_free(struct nrf_cloud_fota_job_info *const job);
 
int nrf_cloud_coap_fota_job_update(const char *const job_id,
        const enum nrf_cloud_fota_status status, const char * const details);
 
int nrf_cloud_coap_shadow_get(char *buf, size_t *buf_len, bool delta,
                              enum coap_content_format format);
 
int nrf_cloud_coap_shadow_state_update(const char * const shadow_json);
 
int nrf_cloud_coap_shadow_desired_update(const char * const shadow_json);
 
int nrf_cloud_coap_shadow_device_status_update(const struct nrf_cloud_device_status
                                               *const dev_status);
 
int nrf_cloud_coap_shadow_service_info_update(const struct nrf_cloud_svc_info * const svc_inf);
 
int nrf_cloud_coap_shadow_delta_process(const struct nrf_cloud_data *in_data,
                                        struct nrf_cloud_obj *const delta_out);
 
int nrf_cloud_coap_bytes_send(uint8_t *buf, size_t buf_len, bool confirmable);
 
int nrf_cloud_coap_obj_send(struct nrf_cloud_obj *const obj, bool confirmable);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_CLOUD_COAP_H_ */