Skip to content

Namespace PAYLOAD_ENCODER

Namespace List > PAYLOAD_ENCODER

Classes

Type Name
class CayenneLPP <MaxSize>
Template class for CayenneLPP payload encoder.

Public Types

Type Name
enum uint8_t DATA_TYPES
Enum class defining data types for Cayenne LPP.
enum size_t DATA_TYPES_SIZES
Enum class defining sizes of data types for Cayenne LPP.
enum uint8_t ERROR_TYPES
Enum class defining error types for Cayenne LPP.

Public Static Functions

Type Name
const int16_t FLOATING_DATA_RESOLUTION (DATA_TYPES dataType)
Function to get the resolution for floating point data types.
const size_t getDataTypeSize (DATA_TYPES dataType)
Function to create a mapping between data types reference and respective size in bytes.

Public Types Documentation

enum DATA_TYPES

enum PAYLOAD_ENCODER::DATA_TYPES {
    DIG_IN = 0,
    DIG_OUT = 1,
    ANL_IN = 2,
    ANL_OUT = 3,
    ILLUM_SENS = 101,
    PRSNC_SENS = 102,
    TEMP_SENS = 103,
    HUM_SENS = 104,
    ACCRM_SENS = 113,
    BARO_SENS = 115,
    GYRO_SENS = 134,
    GPS_LOC = 136
};

enum DATA_TYPES_SIZES

enum PAYLOAD_ENCODER::DATA_TYPES_SIZES {
    DIG_IN = 1,
    DIG_OUT = 1,
    ANL_IN = 2,
    ANL_OUT = 2,
    ILLUM_SENS = 2,
    PRSNC_SENS = 1,
    TEMP_SENS = 2,
    HUM_SENS = 2,
    ACCRM_SENS = 6,
    BARO_SENS = 2,
    GYRO_SENS = 6,
    GPS_LOC = 12
};

enum ERROR_TYPES

enum PAYLOAD_ENCODER::ERROR_TYPES {
    LPP_ERROR_OVERFLOW = 0,
    LPP_ERROR_UNKOWN_TYPE = 1,
    LPP_ERROR_OK = 2
};

Public Static Functions Documentation

function FLOATING_DATA_RESOLUTION

Function to get the resolution for floating point data types.

static inline const int16_t PAYLOAD_ENCODER::FLOATING_DATA_RESOLUTION (
    DATA_TYPES dataType
) 

Parameters:

  • dataType The data type.

Returns:

The resolution of the data type.

function getDataTypeSize

Function to create a mapping between data types reference and respective size in bytes.

static inline const size_t PAYLOAD_ENCODER::getDataTypeSize (
    DATA_TYPES dataType
) 

Parameters:

  • dataType The data type.

Returns:

The size of the data type in bytes.


The documentation for this class was generated from the following file include/CayenneLPP.hpp