phydat.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Freie Universit├Ąt Berlin
3  *
4  * This file is subject to the terms and conditions of the GNU Lesser
5  * General Public License v2.1. See the file LICENSE in the top level
6  * directory for more details.
7  */
8 
35 #ifndef PHYDAT_H
36 #define PHYDAT_H
37 
38 #include <stddef.h>
39 #include <stdint.h>
40 #include "modules.h"
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
57 #define PHYDAT_DIM (3U)
58 
62 #define PHYDAT_SCALE_STR_MAXLEN (sizeof("*E-128\0"))
63 
75 enum {
76  /* generic values */
79  /* temperature */
83  /* illuminance */
85  /* dimension */
89  /* kinetic */
92  /* weight */
93  UNIT_GR,
95  /* electricity */
105  /* electrochemical */
107  /* pressure */
110  /* light */
112  /* logical */
119  /* aggregate values */
122  /* mass concentration */
124  /* number concentration */
125  UNIT_CPM3
126  /* extend this list as needed */
127 };
128 
150 typedef struct {
151  int16_t val[PHYDAT_DIM];
152  uint8_t unit;
153  int8_t scale;
154 } phydat_t;
155 
159 #define PHYDAT_MIN (INT16_MIN)
160 
164 #define PHYDAT_MAX (INT16_MAX)
165 
172 void phydat_dump(phydat_t *data, uint8_t dim);
173 
182 const char *phydat_unit_to_str(uint8_t unit);
183 
199 const char *phydat_unit_to_str_verbose(uint8_t unit);
200 
212 char phydat_prefix_from_scale(int8_t scale);
213 
244 void phydat_fit(phydat_t *dat, const int32_t *values, unsigned int dim);
245 
289 size_t phydat_to_json(const phydat_t *data, size_t dim, char *buf);
290 
301 int64_t phydat_date_time_to_unix(phydat_t *date, phydat_t *time, int32_t offset_seconds);
302 
316 int64_t phydat_unix(int16_t year, int16_t month, int16_t day,
317  int16_t hour, int16_t minute, int16_t second,
318  int32_t offset);
319 
320 #ifdef __cplusplus
321 }
322 #endif
323 
324 #endif /* PHYDAT_H */
const char * phydat_unit_to_str_verbose(uint8_t unit)
Return a string representation for every unit, including non-physical units like 'none' or 'time'.
#define PHYDAT_DIM
The fixed number of dimensions we work with.
Definition: phydat.h:57
char phydat_prefix_from_scale(int8_t scale)
Convert the given scale factor to an SI prefix.
int64_t phydat_date_time_to_unix(phydat_t *date, phydat_t *time, int32_t offset_seconds)
Convert a date and time contained in phydat structs to a Unix timestamp.
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)
Convert a date and time (per ISO8601) to a Unix timestamp (seconds since 1970).
const char * phydat_unit_to_str(uint8_t unit)
Convert the given unit to a string.
size_t phydat_to_json(const phydat_t *data, size_t dim, char *buf)
Convert the given phydat_t structure into a JSON string.
void phydat_fit(phydat_t *dat, const int32_t *values, unsigned int dim)
Scale integer value(s) to fit into a phydat_t.
void phydat_dump(phydat_t *data, uint8_t dim)
Dump the given data container to STDIO.
@ UNIT_M2
square meters
Definition: phydat.h:87
@ UNIT_TEMP_C
degree Celsius
Definition: phydat.h:80
@ UNIT_W
Watt.
Definition: phydat.h:98
@ UNIT_COULOMB
coulomb
Definition: phydat.h:102
@ UNIT_PA
Pascal.
Definition: phydat.h:109
@ UNIT_A
Ampere.
Definition: phydat.h:96
@ UNIT_PERCENT
out of 100
Definition: phydat.h:115
@ UNIT_TEMP_K
Kelvin.
Definition: phydat.h:82
@ UNIT_NONE
data has no physical unit
Definition: phydat.h:78
@ UNIT_UNDEF
unit undefined
Definition: phydat.h:77
@ UNIT_TEMP_F
degree Fahrenheit
Definition: phydat.h:81
@ UNIT_GS
gauss
Definition: phydat.h:99
@ UNIT_PPB
part per billion
Definition: phydat.h:118
@ UNIT_DATE
the 3 dimensions contain days, months and years
Definition: phydat.h:121
@ UNIT_G
gravitational force
Definition: phydat.h:90
@ UNIT_PH
pH
Definition: phydat.h:106
@ UNIT_CD
Candela.
Definition: phydat.h:111
@ UNIT_DPS
degree per second
Definition: phydat.h:91
@ UNIT_T
Tesla.
Definition: phydat.h:100
@ UNIT_V
Volts.
Definition: phydat.h:97
@ UNIT_PPM
part per million
Definition: phydat.h:117
@ UNIT_GPM3
grams per cubic meter
Definition: phydat.h:123
@ UNIT_DBM
decibel-milliwatts
Definition: phydat.h:101
@ UNIT_PERMILL
out of 1000
Definition: phydat.h:116
@ UNIT_GR
grams - not using the SI unit (kg) here to make scale handling simpler
Definition: phydat.h:93
@ UNIT_M3
cubic meters
Definition: phydat.h:88
@ UNIT_TIME
the three dimensions contain sec, min, and hours
Definition: phydat.h:120
@ UNIT_BOOL
boolean value [0|1]
Definition: phydat.h:113
@ UNIT_CPM3
count per cubic meter
Definition: phydat.h:125
@ UNIT_CTS
counts
Definition: phydat.h:114
@ UNIT_LUX
Lux (lx)
Definition: phydat.h:84
@ UNIT_F
Farad.
Definition: phydat.h:103
@ UNIT_BAR
Beer?
Definition: phydat.h:108
@ UNIT_OHM
Ohm.
Definition: phydat.h:104
@ UNIT_M
meters
Definition: phydat.h:86
Common macros and compiler attributes/pragmas configuration.
Generic data structure for expressing physical values.
Definition: phydat.h:150
int8_t scale
the scale factor, 10^*scale*
Definition: phydat.h:153
uint8_t unit
the (physical) unit of the data
Definition: phydat.h:152