nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches
nrf_cloud_alert.h File Reference

Module to provide mechanism to send application alerts to nRF Cloud. More...

#include <zephyr/kernel.h>
#include <math.h>

Go to the source code of this file.

Data Structures

struct  nrf_cloud_alert_info
 Alert data. More...
 

Macros

#define NRF_CLOUD_ALERT_UNUSED_VALUE   NAN
 Special value to pass when value should not be sent.
 

Enumerations

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
}
 Alert type. More...
 

Functions

int nrf_cloud_alert_send (enum nrf_cloud_alert_type type, float value, const char *description)
 Transmit the specified alert to nRF Cloud using MQTT or CoAP.
 
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)
 Transmit the specified alert to nRF Cloud using REST.
 
void nrf_cloud_alert_control_set (bool alerts_enable)
 Enable or disable use of alerts.
 
bool nrf_cloud_alert_control_get (void)
 Find out if alerts are enabled.
 

Detailed Description

Module to provide mechanism to send application alerts to nRF Cloud.