sensor_data_types.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Google LLC
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_SENSOR_DATA_TYPES_H
#define ZEPHYR_INCLUDE_DRIVERS_SENSOR_DATA_TYPES_H
 
#include <zephyr/dsp/types.h>
#include <zephyr/dsp/print_format.h>
 
#include <inttypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct sensor_data_header {
        uint64_t base_timestamp_ns;
        uint16_t reading_count;
};
 
struct sensor_three_axis_data {
        struct sensor_data_header header;
        int8_t shift;
        struct sensor_three_axis_sample_data {
                uint32_t timestamp_delta;
                union {
                        q31_t values[3];
                        q31_t v[3];
                        struct {
                                q31_t x;
                                q31_t y;
                                q31_t z;
                        };
                };
        } readings[1];
};
 
#define PRIsensor_three_axis_data PRIu64 "ns, (%" PRIq(6) ", %" PRIq(6) ", %" PRIq(6) ")"
 
#define PRIsensor_three_axis_data_arg(data_, readings_offset_)                                     \
        (data_).header.base_timestamp_ns + (data_).readings[(readings_offset_)].timestamp_delta,   \
                PRIq_arg((data_).readings[(readings_offset_)].x, 6, (data_).shift),                \
                PRIq_arg((data_).readings[(readings_offset_)].y, 6, (data_).shift),                \
                PRIq_arg((data_).readings[(readings_offset_)].z, 6, (data_).shift)
 
struct sensor_occurrence_data {
        struct sensor_data_header header;
        struct sensor_occurrence_sample_data {
                uint32_t timestamp_delta;
        } readings[1];
};
 
#define PRIsensor_occurrence_data PRIu64 "ns"
 
#define PRIsensor_occurrence_data_arg(data_, readings_offset_)                                     \
        (data_).header.base_timestamp_ns + (data_).readings[(readings_offset_)].timestamp_delta
 
struct sensor_q31_data {
        struct sensor_data_header header;
        int8_t shift;
        struct sensor_q31_sample_data {
                uint32_t timestamp_delta;
                union {
                        q31_t value;
                        q31_t light;           
                        q31_t pressure;        
                        q31_t temperature;     
                        q31_t percent;         
                        q31_t distance;        
                        q31_t density;         
                        q31_t density_ppm;     
                        q31_t density_ppb;     
                        q31_t resistance;      
                        q31_t voltage;         
                        q31_t current;         
                        q31_t power;           
                        q31_t angle;           
                        q31_t electric_charge; 
                        q31_t humidity;        
                };
        } readings[1];
};
 
#define PRIsensor_q31_data PRIu64 "ns (%" PRIq(6) ")"
 
#define PRIsensor_q31_data_arg(data_, readings_offset_)                                            \
        (data_).header.base_timestamp_ns + (data_).readings[(readings_offset_)].timestamp_delta,   \
                PRIq_arg((data_).readings[(readings_offset_)].value, 6, (data_).shift)
 
struct sensor_byte_data {
        struct sensor_data_header header;
        struct sensor_byte_sample_data {
                uint32_t timestamp_delta;
                union {
                        uint8_t value;
                        struct {
                                uint8_t is_near: 1;
                                uint8_t padding: 7;
                        };
                };
        } readings[1];
};
 
#define PRIsensor_byte_data(field_name_) PRIu64 "ns (" STRINGIFY(field_name_) " = %" PRIu8 ")"
 
#define PRIsensor_byte_data_arg(data_, readings_offset_, field_name_)                              \
        (data_).header.base_timestamp_ns + (data_).readings[(readings_offset_)].timestamp_delta,   \
                (data_).readings[(readings_offset_)].field_name_
 
struct sensor_uint64_data {
        struct sensor_data_header header;
        struct sensor_uint64_sample_data {
                uint32_t timestamp_delta;
                uint64_t value;
        } readings[1];
};
 
#define PRIsensor_uint64_data PRIu64 "ns (%" PRIu64 ")"
 
#define PRIsensor_uint64_data_arg(data_, readings_offset_)                                         \
        (data_).header.base_timestamp_ns + (data_).readings[(readings_offset_)].timestamp_delta,   \
                (data_).readings[(readings_offset_)].value
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_SENSOR_DATA_TYPES_H */