nrf_cloud_rest.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_CLOUD_REST_H__
#define NRF_CLOUD_REST_H__
 
#include <zephyr/types.h>
#include <net/nrf_cloud.h>
#include <net/nrf_cloud_pgps.h>
#include <net/nrf_cloud_location.h>
#include <modem/lte_lc.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum nrf_cloud_http_status {
        NRF_CLOUD_HTTP_STATUS_UNHANDLED = -1,
        NRF_CLOUD_HTTP_STATUS_NONE = 0,
        NRF_CLOUD_HTTP_STATUS_OK = 200,
        NRF_CLOUD_HTTP_STATUS_ACCEPTED = 202,
        NRF_CLOUD_HTTP_STATUS_PARTIAL = 206,
        NRF_CLOUD_HTTP_STATUS__ERROR_BEGIN = 400,
        NRF_CLOUD_HTTP_STATUS_BAD_REQ = NRF_CLOUD_HTTP_STATUS__ERROR_BEGIN,
        NRF_CLOUD_HTTP_STATUS_UNAUTH = 401,
        NRF_CLOUD_HTTP_STATUS_FORBIDDEN = 403,
        NRF_CLOUD_HTTP_STATUS_NOT_FOUND = 404,
        NRF_CLOUD_HTTP_STATUS_BAD_RANGE = 416,
        NRF_CLOUD_HTTP_STATUS_UNPROC_ENTITY = 422,
};
 
enum nrf_cloud_rest_agnss_req_type {
        NRF_CLOUD_REST_AGNSS_REQ_ASSISTANCE,
        NRF_CLOUD_REST_AGNSS_REQ_LOCATION,
        NRF_CLOUD_REST_AGNSS_REQ_CUSTOM
};
 
#define NRF_CLOUD_REST_TIMEOUT_NONE             (SYS_FOREVER_MS)
 
struct nrf_cloud_rest_context {
 
        int connect_socket;
        bool keep_alive;
        int32_t timeout_ms;
        char *auth;
        char *rx_buf;
        size_t rx_buf_len;
        size_t fragment_size;
 
        enum nrf_cloud_http_status status;
        char *response;
        size_t response_len;
        size_t total_response_len;
 
        enum nrf_cloud_error nrf_err;
};
 
struct nrf_cloud_rest_location_request {
        struct lte_lc_cells_info *cell_info;
        struct wifi_scan_info *wifi_info;
        const struct nrf_cloud_location_config *config;
};
 
struct nrf_cloud_rest_agnss_request {
        enum nrf_cloud_rest_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_rest_agnss_result {
        char *buf;
        size_t buf_sz;
        size_t agnss_sz;
};
 
struct nrf_cloud_rest_pgps_request {
        const struct gps_pgps_request *pgps_req;
};
 
int nrf_cloud_rest_location_get(struct nrf_cloud_rest_context *const rest_ctx,
        struct nrf_cloud_rest_location_request const *const request,
        struct nrf_cloud_location_result *const result);
 
#if defined(CONFIG_NRF_CLOUD_AGNSS)
int nrf_cloud_rest_agnss_data_get(struct nrf_cloud_rest_context *const rest_ctx,
        struct nrf_cloud_rest_agnss_request const *const request,
        struct nrf_cloud_rest_agnss_result *const result);
#endif /* CONFIG_NRF_CLOUD_AGNSS */
 
#if defined(CONFIG_NRF_CLOUD_PGPS)
int nrf_cloud_rest_pgps_data_get(struct nrf_cloud_rest_context *const rest_ctx,
        struct nrf_cloud_rest_pgps_request const *const request);
#endif
 
int nrf_cloud_rest_fota_job_get(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, struct nrf_cloud_fota_job_info *const job);
 
void nrf_cloud_rest_fota_job_free(struct nrf_cloud_fota_job_info *const job);
 
int nrf_cloud_rest_fota_job_update(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const char *const job_id,
        const enum nrf_cloud_fota_status status, const char * const details);
 
int nrf_cloud_rest_shadow_transform_request(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, char const *const transform);
 
int nrf_cloud_rest_shadow_state_update(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const char * const shadow_json);
 
int nrf_cloud_rest_shadow_service_info_update(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const struct nrf_cloud_svc_info * const svc_inf);
 
int nrf_cloud_rest_shadow_device_status_update(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const struct nrf_cloud_device_status *const dev_status);
 
int nrf_cloud_rest_disconnect(struct nrf_cloud_rest_context *const rest_ctx);
 
int nrf_cloud_rest_jitp(const sec_tag_t nrf_cloud_sec_tag);
 
int nrf_cloud_rest_send_device_message(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const char *const json_msg, const bool bulk,
        const char *const topic);
 
int nrf_cloud_rest_send_location(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const struct nrf_cloud_gnss_data * const gnss);
 
int nrf_cloud_rest_device_status_message_send(struct nrf_cloud_rest_context *const rest_ctx,
        const char *const device_id, const struct nrf_cloud_device_status *const dev_status,
        const int64_t timestamp_ms);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_CLOUD_REST_H__ */