nrf_cloud_alert.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_CLOUD_ALERT_H_
#define NRF_CLOUD_ALERT_H_
 
#include <zephyr/kernel.h>
#include <math.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct nrf_cloud_rest_context;
 
#define NRF_CLOUD_ALERT_UNUSED_VALUE NAN
 
enum nrf_cloud_alert_type {
        ALERT_TYPE_NONE,
        ALERT_TYPE_DEVICE_NOW_ONLINE,
        ALERT_TYPE_DEVICE_NOW_ONLINE_WDT,
        ALERT_TYPE_DEVICE_GOING_OFFLINE,
        ALERT_TYPE_MSG,
        ALERT_TYPE_TEMPERATURE,
        ALERT_TYPE_HUMIDITY,
        ALERT_TYPE_BATTERY,
        ALERT_TYPE_SHOCK,
        ALERT_TYPE_CUSTOM = 100
};
 
struct nrf_cloud_alert_info {
        enum nrf_cloud_alert_type type;
        float value;
        const char *description;
        unsigned int sequence;
        int64_t ts_ms;
};
 
#if defined(CONFIG_NRF_CLOUD_ALERT) || defined(__DOXYGEN__)
int nrf_cloud_alert_send(enum nrf_cloud_alert_type type, float value, const char *description);
#else
static inline int nrf_cloud_alert_send(enum nrf_cloud_alert_type type, float value,
                                       const char *description)
{
        return 0;
}
#endif /* CONFIG_NRF_CLOUD_ALERT */
 
#if defined(CONFIG_NRF_CLOUD_ALERT) || defined(__DOXYGEN__)
int nrf_cloud_rest_alert_send(struct nrf_cloud_rest_context *const rest_ctx,
                              const char *const device_id,
                              enum nrf_cloud_alert_type type,
                              float value,
                              const char *description);
#else
static inline int nrf_cloud_rest_alert_send(struct nrf_cloud_rest_context *const rest_ctx,
                                            const char *const device_id,
                                            enum nrf_cloud_alert_type type,
                                            float value,
                                            const char *description)
{
        return 0;
}
#endif /* CONFIG_NRF_CLOUD_ALERT */
 
void nrf_cloud_alert_control_set(bool alerts_enable);
 
bool nrf_cloud_alert_control_get(void);
 
#ifdef __cplusplus
#endif
 
#endif /* NRF_CLOUD_ALERT_H_ */