ruuvi_driver_sensor.h

Go to the documentation of this file.

#ifndef RUUVI_DRIVER_SENSOR_H
#define RUUVI_DRIVER_SENSOR_H
#include "ruuvi_driver_error.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#define RD_SENSOR_INVALID_VALUE    RD_FLOAT_INVALID  
#define RD_SENSOR_INVALID_TIMSTAMP RD_UINT64_INVALID 
 
// Constants for sensor configuration and status
#define RD_SENSOR_CFG_DEFAULT         (0U)      
#define RD_SENSOR_CFG_CUSTOM_1        (0xC9U)   
#define RD_SENSOR_CFG_CUSTOM_2        (0xCAU)   
#define RD_SENSOR_CFG_CUSTOM_3        (0xCBU)   
#define RD_SENSOR_CFG_CUSTOM_4        (0xCCU)   
#define RD_SENSOR_CFG_CUSTOM_5        (0xCDU)   
#define RD_SENSOR_CFG_CUSTOM_6        (0xCEU)   
#define RD_SENSOR_ERR_INVALID         (0xE0U)   
#define RD_SENSOR_ERR_NOT_IMPLEMENTED (0xE1U)   
#define RD_SENSOR_ERR_NOT_SUPPORTED   (0xE2U)   
#define RD_SENSOR_CFG_MIN             (0xF0U)   
#define RD_SENSOR_CFG_MAX             (0xF1U)   
#define RD_SENSOR_CFG_SLEEP           (0xF2U)   
#define RD_SENSOR_CFG_SINGLE          (0xF3U)   
#define RD_SENSOR_CFG_CONTINUOUS      (0xF4U)   
#define RD_SENSOR_CFG_NO_CHANGE       (0xFFU)   
 
// DSP functions, complemented by DSP parameter
#define RD_SENSOR_DSP_LAST            (0U)    
#define RD_SENSOR_DSP_LOW_PASS        (1U<<1U) 
#define RD_SENSOR_DSP_HIGH_PASS       (1U<<2U) 
#define RD_SENSOR_DSP_OS              (1U<<3U) 
 
#define RD_GPIO_TO_HANDLE(handle) ((((handle) >> 3U) & 0xE0U) + ((handle) & 0x1FU))
#define RD_HANDLE_TO_GPIO(handle) ((((handle) & 0xE0U) << 3U) + ((handle) & 0x1FU))
#define RD_HANDLE_UNUSED (0xFFU)
 
#ifndef UNUSED_VARIABLE
#   define UNUSED_VARIABLE(X)  ((void)(X))
#endif
 
typedef struct __attribute__ ( (packed, aligned (4)))
{
    uint8_t samplerate;     
    uint8_t resolution;     
    uint8_t scale;          
    uint8_t dsp_function;   
    uint8_t dsp_parameter;  
    uint8_t mode;           
    uint8_t reserved0;      
    uint8_t reserved1;      
}
rd_sensor_configuration_t;
 
typedef enum
{
    RD_BUS_NONE = 0U, 
    RD_BUS_SPI  = 1U, 
    RD_BUS_I2C  = 2U, 
    RD_BUS_UART = 3U, 
    RD_BUS_PDM  = 4U, 
    RD_BUS_FAIL = 5U  
} rd_bus_t;
 
typedef struct
{
    unsigned int acceleration_x_g : 1; 
    unsigned int acceleration_y_g : 1; 
    unsigned int acceleration_z_g : 1; 
    unsigned int co2_ppm : 1;          
    unsigned int gyro_x_dps : 1;       
    unsigned int gyro_y_dps : 1;       
    unsigned int gyro_z_dps : 1;       
    unsigned int humidity_rh : 1;      
    unsigned int luminosity  : 1;
    unsigned int magnetometer_x_g : 1; 
    unsigned int magnetometer_y_g : 1; 
    unsigned int magnetometer_z_g : 1; 
    unsigned int pm_1_ugm3 : 1;        
    unsigned int pm_2_ugm3 : 1;        
    unsigned int pm_4_ugm3 : 1;        
    unsigned int pm_10_ugm3 : 1;       
    unsigned int pressure_pa : 1;      
    unsigned int spl_dbz : 1;          
    unsigned int temperature_c : 1;    
    unsigned int voc_ppm : 1;          
    unsigned int voltage_v : 1;        
    unsigned int voltage_ratio : 1;    
    unsigned int reserved: 10;         
} rd_sensor_data_bitfield_t;
 
#define RD_SENSOR_ACC_X_FIELD ((rd_sensor_data_fields_t){.datas.acceleration_x_g=1})
#define RD_SENSOR_ACC_Y_FIELD ((rd_sensor_data_fields_t){.datas.acceleration_y_g=1})
#define RD_SENSOR_ACC_Z_FIELD ((rd_sensor_data_fields_t){.datas.acceleration_z_g=1})
#define RD_SENSOR_GYR_X_FIELD ((rd_sensor_data_fields_t){.datas.gyro_x_dps=1})
#define RD_SENSOR_GYR_Y_FIELD ((rd_sensor_data_fields_t){.datas.gyro_y_dps=1})
#define RD_SENSOR_GYR_Z_FIELD ((rd_sensor_data_fields_t){.datas.gyro_z_dps=1})
#define RD_SENSOR_HUMI_FIELD ((rd_sensor_data_fields_t){.datas.humidity_rh=1})
#define RD_SENSOR_PRES_FIELD ((rd_sensor_data_fields_t){.datas.pressure_pa=1})
#define RD_SENSOR_TEMP_FIELD ((rd_sensor_data_fields_t){.datas.temperature_c=1})
 
 
 
typedef union // -V2514
{
    uint32_t bitfield; 
    rd_sensor_data_bitfield_t datas; 
} rd_sensor_data_fields_t;
 
typedef struct rd_sensor_data_t
{
    uint64_t timestamp_ms;      
    rd_sensor_data_fields_t
    fields; 
    rd_sensor_data_fields_t valid;  
    float * data;
} rd_sensor_data_t;
 
typedef struct rd_sensor_t rd_sensor_t;
 
typedef rd_status_t (*rd_sensor_init_fp) (rd_sensor_t * const
        p_sensor, const rd_bus_t bus, const uint8_t handle);
 
typedef rd_status_t (*rd_sensor_setup_fp) (uint8_t * parameter);
 
typedef rd_status_t (*rd_sensor_dsp_fp) (uint8_t * dsp_function,
        uint8_t * dsp_parameter);
 
typedef rd_status_t (*rd_sensor_data_fp) (rd_sensor_data_t * const p_data);
 
typedef rd_status_t (*rd_configuration_fp) (
    const rd_sensor_t * const p_sensor,
    rd_sensor_configuration_t * const p_configuration);
 
typedef rd_status_t (*rd_sensor_fifo_read_fp) (size_t * const num_elements,
        rd_sensor_data_t * const data);
 
typedef rd_status_t (*rd_sensor_fifo_enable_fp) (const bool enable);
 
typedef rd_status_t (*rd_sensor_level_interrupt_use_fp) (const bool enable,
        float * limit_g);
 
typedef uint64_t (*rd_sensor_timestamp_fp) (void);
 
typedef struct rd_sensor_t
{
    const char * name;
    void * p_ctx;
    rd_sensor_data_fields_t provides;
    rd_sensor_init_fp  init;
    rd_sensor_init_fp  uninit;
    rd_sensor_setup_fp samplerate_set;
    rd_sensor_setup_fp samplerate_get;
    rd_sensor_setup_fp resolution_set;
    rd_sensor_setup_fp resolution_get;
    rd_sensor_setup_fp scale_set;
    rd_sensor_setup_fp scale_get;
    rd_sensor_setup_fp mode_set;
    rd_sensor_setup_fp mode_get;
    rd_sensor_dsp_fp   dsp_set;
    rd_sensor_dsp_fp   dsp_get;
    rd_configuration_fp configuration_set;
    rd_configuration_fp configuration_get;
    rd_sensor_data_fp   data_get;
    rd_sensor_fifo_enable_fp fifo_enable;
    rd_sensor_fifo_enable_fp fifo_interrupt_enable;
    rd_sensor_fifo_read_fp   fifo_read;
    rd_sensor_level_interrupt_use_fp level_interrupt_set;
} rd_sensor_t;
 
rd_status_t rd_sensor_configuration_set (const rd_sensor_t *
        sensor, rd_sensor_configuration_t * config);
 
rd_status_t rd_sensor_configuration_get (const rd_sensor_t *
        sensor, rd_sensor_configuration_t * config);
 
rd_status_t rd_sensor_timestamp_function_set (
    const rd_sensor_timestamp_fp  timestamp_fp);
 
uint64_t rd_sensor_timestamp_get (void);
 
void rd_sensor_initialize (rd_sensor_t * const p_sensor);
 
void rd_sensor_uninitialize (rd_sensor_t * const p_sensor);
 
bool rd_sensor_is_init (const rd_sensor_t * const sensor);
 
void rd_sensor_data_populate (rd_sensor_data_t * const target,
                              const rd_sensor_data_t * const provided,
                              const rd_sensor_data_fields_t requested);
 
float rd_sensor_data_parse (const rd_sensor_data_t * const provided,
                            const rd_sensor_data_fields_t requested);
 
uint8_t rd_sensor_data_fieldcount (const rd_sensor_data_t * const target);
 
void rd_sensor_data_set (rd_sensor_data_t * const target,
                         const rd_sensor_data_fields_t field,
                         const float value);
 
rd_status_t validate_default_input_set (uint8_t * const input, const uint8_t mode);
 
rd_status_t validate_default_input_get (uint8_t * const input);
 
bool rd_sensor_has_valid_data (const rd_sensor_data_t * const target,
                               const uint8_t index);
 
rd_sensor_data_bitfield_t rd_sensor_field_type (const rd_sensor_data_t * const target,
        const uint8_t index);
 
#endif