Loading...
Searching...
No Matches
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 <sys/types.h>
41
42#include "modules.h"
43
44#ifdef __cplusplus
45extern "C" {
46#endif
47
59#define PHYDAT_DIM (3U)
60
64#define PHYDAT_SCALE_STR_MAXLEN (sizeof("*E-128\0"))
65
77enum {
78 /* generic values */
81 /* temperature */
85 /* illuminance */
87 /* dimension */
91 /* kinetic */
95 /* weight */
96 UNIT_GRAM,
99 /* electricity */
110 /* electrochemical */
112 /* pressure */
115 /* light */
117 /* logical */
124 /* aggregate values */
127 /* mass concentration */
129 /* number concentration */
130 UNIT_CPM3
131 /* extend this list as needed */
133
155typedef struct {
156 int16_t val[PHYDAT_DIM];
157 uint8_t unit;
158 int8_t scale;
159} phydat_t;
160
164#define PHYDAT_MIN (INT16_MIN)
165
169#define PHYDAT_MAX (INT16_MAX)
170
177void phydat_dump(phydat_t *data, uint8_t dim);
178
193const char *phydat_unit_to_str(uint8_t unit);
194
204const char *phydat_unit_to_str_verbose(uint8_t unit);
205
211void phydat_unit_print(uint8_t unit);
212
229ssize_t phydat_unit_write(char *dest, size_t max_size, uint8_t unit);
230
242char phydat_prefix_from_scale(int8_t scale);
243
274void phydat_fit(phydat_t *dat, const int32_t *values, unsigned int dim);
275
319size_t phydat_to_json(const phydat_t *data, size_t dim, char *buf);
320
331int64_t phydat_date_time_to_unix(phydat_t *date, phydat_t *time, int32_t offset_seconds);
332
346int64_t phydat_unix(int16_t year, int16_t month, int16_t day,
347 int16_t hour, int16_t minute, int16_t second,
348 int32_t offset);
349
350#ifdef __cplusplus
351}
352#endif
353
354#endif /* PHYDAT_H */
void phydat_unit_print(uint8_t unit)
Print a unit.
#define PHYDAT_DIM
The fixed number of dimensions we work with.
Definition phydat.h:59
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.
const char * phydat_unit_to_str_verbose(uint8_t unit)
Same as phydat_unit_to_str.
const char * phydat_unit_to_str(uint8_t unit)
Convert the given unit to a string.
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).
size_t phydat_to_json(const phydat_t *data, size_t dim, char *buf)
Convert the given phydat_t structure into a JSON string.
ssize_t phydat_unit_write(char *dest, size_t max_size, uint8_t unit)
Write the string representation of the given unit into the given buffer.
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:89
@ UNIT_TEMP_C
degree Celsius
Definition phydat.h:82
@ UNIT_G_FORCE
gravitational force equivalent
Definition phydat.h:92
@ UNIT_W
Watt.
Definition phydat.h:102
@ UNIT_COULOMB
coulomb
Definition phydat.h:107
@ UNIT_PA
Pascal.
Definition phydat.h:114
@ UNIT_A
Ampere.
Definition phydat.h:100
@ UNIT_PERCENT
out of 100
Definition phydat.h:120
@ UNIT_TEMP_K
Kelvin.
Definition phydat.h:84
@ UNIT_NONE
data has no physical unit
Definition phydat.h:80
@ UNIT_UNDEF
unit undefined
Definition phydat.h:79
@ UNIT_TEMP_F
degree Fahrenheit
Definition phydat.h:83
@ UNIT_GS
Definition phydat.h:104
@ UNIT_PPB
part per billion
Definition phydat.h:123
@ UNIT_GAUSS
gauss
Definition phydat.h:103
@ UNIT_DATE
the 3 dimensions contain days, months and years
Definition phydat.h:126
@ UNIT_G
Definition phydat.h:93
@ UNIT_PH
pH
Definition phydat.h:111
@ UNIT_CD
Candela.
Definition phydat.h:116
@ UNIT_DPS
degree per second
Definition phydat.h:94
@ UNIT_T
Tesla.
Definition phydat.h:105
@ UNIT_V
Volts.
Definition phydat.h:101
@ UNIT_PPM
part per million
Definition phydat.h:122
@ UNIT_GPM3
grams per cubic meter
Definition phydat.h:128
@ UNIT_DBM
decibel-milliwatts
Definition phydat.h:106
@ UNIT_PERMILL
out of 1000
Definition phydat.h:121
@ UNIT_GR
Definition phydat.h:98
@ UNIT_M3
cubic meters
Definition phydat.h:90
@ UNIT_TIME
the three dimensions contain sec, min, and hours
Definition phydat.h:125
@ UNIT_BOOL
boolean value [0|1]
Definition phydat.h:118
@ UNIT_CPM3
count per cubic meter
Definition phydat.h:130
@ UNIT_CTS
counts
Definition phydat.h:119
@ UNIT_LUX
Lux (lx)
Definition phydat.h:86
@ UNIT_F
Farad.
Definition phydat.h:108
@ UNIT_GRAM
grams - not using the SI unit (kg) here to make scale handling simpler
Definition phydat.h:96
@ UNIT_BAR
Beer?
Definition phydat.h:113
@ UNIT_OHM
Ohm.
Definition phydat.h:109
@ UNIT_M
meters
Definition phydat.h:88
Common macros and compiler attributes/pragmas configuration.
Generic data structure for expressing physical values.
Definition phydat.h:155
int8_t scale
the scale factor, 10^*scale*
Definition phydat.h:158
uint8_t unit
the (physical) unit of the data
Definition phydat.h:157