phydat.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
#include <sys/types.h>
 
#include "modules.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define PHYDAT_DIM                  (3U)
 
#define PHYDAT_SCALE_STR_MAXLEN     (sizeof("*E-128\0"))
 
enum {
    /* generic values */
    UNIT_UNDEF,     
    UNIT_NONE,      
    /* temperature */
    UNIT_TEMP_C,    
    UNIT_TEMP_F,    
    UNIT_TEMP_K,    
    /* illuminance */
    UNIT_LUX,       
    /* dimension */
    UNIT_M,         
    UNIT_M2,        
    UNIT_M3,        
    /* kinetic */
    UNIT_G_FORCE,   
    UNIT_G = UNIT_G_FORCE, 
    UNIT_DPS,       
    /* weight */
    UNIT_GRAM,      
    UNIT_GR = UNIT_GRAM, 
    /* electricity */
    UNIT_A,         
    UNIT_V,         
    UNIT_W,         
    UNIT_GAUSS,     
    UNIT_GS = UNIT_GAUSS, 
    UNIT_T,         
    UNIT_DBM,       
    UNIT_COULOMB,   
    UNIT_F,         
    UNIT_OHM,       
    /* electrochemical */
    UNIT_PH,        
    /* pressure */
    UNIT_BAR,       
    UNIT_PA,        
    /* light */
    UNIT_CD,        
    /* logical */
    UNIT_BOOL,      
    UNIT_CTS,       
    UNIT_PERCENT,   
    UNIT_PERMILL,   
    UNIT_PPM,       
    UNIT_PPB,       
    /* aggregate values */
    UNIT_TIME,      
    UNIT_DATE,      
    /* mass concentration */
    UNIT_GPM3,      
    /* number concentration */
    UNIT_CPM3       
    /* extend this list as needed */
};
 
typedef struct {
    int16_t val[PHYDAT_DIM];    
    uint8_t unit;               
    int8_t scale;               
} phydat_t;
 
#define PHYDAT_MIN  (INT16_MIN)
 
#define PHYDAT_MAX  (INT16_MAX)
 
void phydat_dump(phydat_t *data, uint8_t dim);
 
void phydat_unit_print(uint8_t unit);
 
ssize_t phydat_unit_write(char *dest, size_t max_size, uint8_t unit);
 
char phydat_prefix_from_scale(int8_t scale);
 
void phydat_fit(phydat_t *dat, const int32_t *values, unsigned int dim);
 
size_t phydat_to_json(const phydat_t *data, size_t dim, char *buf);
 
int64_t phydat_date_time_to_unix(phydat_t *date, phydat_t *time, int32_t offset_seconds);
 
int64_t phydat_unix(int16_t year, int16_t month, int16_t day,
                    int16_t hour, int16_t minute, int16_t second,
                    int32_t offset);
 
#ifdef __cplusplus
}
#endif