measurement.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Linaro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZSL_MEASUREMENT_H__
#define ZSL_MEASUREMENT_H__
 
#include <zsl/zsl.h>
#include <zsl/measurement/base.h>
#include <zsl/measurement/ext_color.h>
#include <zsl/measurement/ext_light.h>
#include <zsl/measurement/ext_temperature.h>
#include <zsl/measurement/unit.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct zsl_mes_header {
    union {
        struct {
            uint8_t base_type;
            uint8_t ext_type;
            union {
                struct {
                    uint16_t data_format : 3;
                    uint16_t encoding : 4;
                    uint16_t compression : 3;
                    uint16_t timestamp : 3;
                    uint16_t _rsvd : 3;
                } flags;
                uint16_t flags_bits;
            };
        } filter;
        uint32_t filter_bits;
    };
 
    union {
        struct {
            uint16_t si_unit;
 
            uint8_t ctype;
 
            int8_t scale_factor;
        } unit;
        uint32_t unit_bits;
    };
 
    union {
        struct {
            uint16_t len;
            struct {
                uint8_t fragment : 2;
                uint8_t _rsvd : 2;
                uint8_t samples : 4;
            };
            uint8_t sourceid;
        } srclen;
        uint32_t srclen_bits;
    };
};
 
struct zsl_measurement {
    struct zsl_mes_header header;
 
    void *payload;
};
 
enum zsl_mes_format {
    ZSL_MES_FORMAT_NONE     = 0,
    ZSL_MES_FORMAT_CBOR     = 1,
};
 
enum zsl_mes_encoding {
    ZSL_MES_ENCODING_NONE   = 0,
    ZSL_MES_ENCODING_BASE64 = 1,
    ZSL_MES_ENCODING_BASE45 = 2,
};
 
enum zsl_mes_compression {
    ZSL_MES_COMPRESSION_NONE        = 0,
    ZSL_MES_COMPRESSION_LZ4         = 1,
};
 
enum zsl_mes_fragment {
    ZSL_MES_FRAGMENT_NONE           = 0,
    ZSL_MES_FRAGMENT_PARTIAL        = 1,
    ZSL_MES_FRAGMENT_FINAL          = 2,
};
 
enum zsl_mes_timestamp {
    ZSL_MES_TIMESTAMP_NONE          = 0,
    ZSL_MES_TIMESTAMP_EPOCH_32      = 1,
    ZSL_MES_TIMESTAMP_EPOCH_64      = 2,
    ZSL_MES_TIMESTAMP_UPTIME_MS_32  = 3,
    ZSL_MES_TIMESTAMP_UPTIME_MS_64  = 4,
    ZSL_MES_TIMESTAMP_UPTIME_US_64  = 5,
};
 
/*
 * @addtogroup MES_FUNCTIONS Functions
 *
 * @brief Measurement API functions
 *
 * @ingroup MEASUREMENT
 *  @{
 */
 
void zsl_mes_print(struct zsl_measurement *sample);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZSL_MEASUREMENT_H_ */