CayenneLpp.h

Go to the documentation of this file.

/*!
  * @file      CayenneLpp.h
  *
  * @brief     Implements the Cayenne Low Power Protocol
  *
  * @copyright Revised BSD License, see section \ref LICENSE.
  *
  * @code
  *                ______                              _
  *               / _____)             _              | |
  *              ( (____  _____ ____ _| |_ _____  ____| |__
  *               \____ \| ___ |    (_   _) ___ |/ ___)  _ \
  *               _____) ) ____| | | || |_| ____( (___| | | |
  *              (______/|_____)_|_|_| \__)_____)\____)_| |_|
  *              (C)2013-2018 Semtech
  *
  * @endcode
  *
  * @author    Miguel Luis ( Semtech )
  */
#ifndef __CAYENNE_LPP_H__
#define __CAYENNE_LPP_H__
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Includes ------------------------------------------------------------------*/
#include <stdint.h>
 
/* USER CODE BEGIN Includes */
 
/* USER CODE END Includes */
 
/* Exported types ------------------------------------------------------------*/
/* USER CODE BEGIN ET */
 
/* USER CODE END ET */
 
/* Exported constants --------------------------------------------------------*/
/* USER CODE BEGIN EC */
 
/* USER CODE END EC */
 
/* External variables --------------------------------------------------------*/
/* USER CODE BEGIN EV */
 
/* USER CODE END EV */
 
/* Exported macro ------------------------------------------------------------*/
/* USER CODE BEGIN EM */
 
/* USER CODE END EM */
 
/* Exported functions prototypes ---------------------------------------------*/
void CayenneLppInit(void);
 
void CayenneLppReset(void);
 
uint8_t CayenneLppGetSize(void);
 
uint8_t *CayenneLppGetBuffer(void);
 
uint8_t CayenneLppCopy(uint8_t *buffer);
 
uint8_t CayenneLppAddDigitalInput(uint8_t channel, uint8_t value);
 
uint8_t CayenneLppAddDigitalOutput(uint8_t channel, uint8_t value);
 
uint8_t CayenneLppAddAnalogInput( uint8_t channel, float value );
 
uint8_t CayenneLppAddAnalogOutput( uint8_t channel, float value );
 
uint8_t CayenneLppAddLuminosity(uint8_t channel, uint16_t lux);
 
uint8_t CayenneLppAddPresence(uint8_t channel, uint8_t value);
 
uint8_t CayenneLppAddTemperature( uint8_t channel, float celsius );
 
uint8_t CayenneLppAddRelativeHumidity( uint8_t channel, float rh );
 
uint8_t CayenneLppAddAccelerometer( uint8_t channel, float x, float y, float z );
 
uint8_t CayenneLppAddBarometricPressure( uint8_t channel, float hpa );
 
uint8_t CayenneLppAddGyrometer( uint8_t channel, float x, float y, float z );
 
uint8_t CayenneLppAddGps( uint8_t channel, float latitude, float longitude, float meters );
 
/* USER CODE BEGIN EFP */
 
/**
 * @brief
 * @retval the max number in bytes for CayenneLpp buffer
 */
uint8_t CayenneLppMaxBuffer();
 
/**
 * @brief Add CO2 concentration data to the buffer
 * @param channel Data channel
 * @param ppm CO2 concentration in parts per million (ppm)
 * @return Current buffer position
 */
uint8_t CayenneLppAddConcentration(uint8_t channel, uint16_t ppm);
 
/**
 * @brief Add voltage data to the buffer
 * @param channel Data channel
 * @param voltage Voltage in volts
 * @return Current buffer position
 */
uint8_t CayenneLppAddVoltage(uint8_t channel, float voltage);
 
/**
 * @brief Add particulate matter of 1mm concentration data to the buffer
 * @param channel Data channel
 * @param concentration_1_0 Particle concentration of 1mm in μg/m³
 * @return Current buffer position
 */
uint8_t CayenneLppAddParticulateMatter_1_0(uint8_t channel, float concentration_1_0);
 
/**
 * @brief Add particulate matter 2.5mm concentration data to the buffer
 * @param channel Data channel
 * @param concentration_2_5 Particle concentration of 2.5mm in μg/m³
 * @return Current buffer position
 */
uint8_t CayenneLppAddParticulateMatter_2_5(uint8_t channel, float concentration_2_5);
 
/**
 * @brief Add UTC time of measuring to the buffer - absolute time of measure
 * @param channel Data channel
 * @param timeMeasure Time value in seconds (uint32_t) - Unix timestamp (seconds since epoch)
 * @return Current buffer position
 */
uint8_t CayenneLppAddTimeMeasureABS(uint8_t channel, uint32_t timeMeasure);
 
/**
 * @brief Add the relative time of measuring - offset from previous measured data less than 255 minutes
 * The time is in minutes, maximum 255 minutes about 4.25hour
 * @param channel Data channel
 * @param timeOffsetMin8 time in minutes
 * @return Current buffer position
 */
uint8_t CayenneLppAddTimeMeasureMIN8(uint8_t channel, uint8_t timeOffsetMin8);
 
/**
 * @brief Add the relative time of measuring - offset from previous measured data less than 65535 minutes (about 45.5days)
 * The time is in minutes, maximum 65535 minutes about 45.5 of days
 * @param channel Data channel
 * @param timeOffsetMin16 time in minutes
 * @return Current buffer position
 */
uint8_t CayenneLppAddTimeMeasureMIN16(uint8_t channel, uint16_t timeOffsetMin16);
 
 
/**
 * @brief Add battery percent of voltage data to the buffer (1B)
 * @param channel Data channel
 * @param perc percentage of battery level, value 0-100
 * @return Current buffer position
 */
uint8_t CayenneLppAddBatteryPerc(uint8_t channel, uint8_t perc);
 
/* USER CODE END EFP */
 
#ifdef __cplusplus
}
#endif
 
#endif /* __CAYENNE_LPP_H__ */