1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/** @file
Various utility functions for use by applications.
Copyright (C) 2015 Tommy Vestermark
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
*/
#ifndef INCLUDE_R_UTIL_H_
#define INCLUDE_R_UTIL_H_
#include <stdint.h>
#include <stdbool.h>
#include <time.h>
#include "compat_time.h"
#if defined _MSC_VER || defined __cplusplus // Microsoft Visual Studio or C++ compilers (G++ is used by ESP32, ESP8266...)
// MSC and C++ compilers have something like C99 restrict as __restrict
#ifndef restrict
#define restrict __restrict
#endif
#endif
// buffer to hold localized timestamp "YYYY-MM-DD HH:MM:SS.000000+0000"
#define LOCAL_TIME_BUFLEN 32
// Macro to prevent unused variables (passed into a function)
// from generating a warning.
#define UNUSED(x) (void)(x)
// Macro to signal that that variable might not be used.
// Useful when a variable is used only in an ifdef block that may or
// may not be enabled.
#define POSSIBLY_UNUSED(x) (void)(x)
/** Get current time with usec precision.
@param tv output for current time
*/
void get_time_now(struct timeval *tv);
/** Printable timestamp in local time.
@param[out] buf output buffer, long enough for "YYYY-MM-DD HH:MM:SS+0000"
@param format time format string, uses "%Y-%m-%d %H:%M:%S" if NULL
@param with_tz 1 to add a time offset, 0 otherwise
@param time_secs 0 for now, or seconds since the epoch
@return buf pointer (for short hand use as operator)
*/
char *format_time_str(char *buf, char const *format, int with_tz, time_t time_secs);
/** Printable timestamp in local time with microseconds.
@param[out] buf output buffer, long enough for "YYYY-MM-DD HH:MM:SS.uuuuuu+0000"
@param format time format string without usec, uses "%Y-%m-%d %H:%M:%S" if NULL
@param with_tz 1 to add a time offset, 0 otherwise
@param tv NULL for now, or seconds and microseconds since the epoch
@return buf pointer (for short hand use as operator)
*/
char *usecs_time_str(char *buf, char const *format, int with_tz, struct timeval *tv);
/** Printable sample position.
@param sample_file_pos sample position
@param buf output buffer, long enough for "@0.000000s"
@return buf pointer (for short hand use as operator)
*/
char *sample_pos_str(float sample_file_pos, char *buf);
/** Convert Celsius to Fahrenheit.
@param celsius temperature in Celsius
@return temperature value in Fahrenheit
*/
float celsius2fahrenheit(float celsius);
/** Convert Fahrenheit to Celsius.
@param fahrenheit temperature in Fahrenheit
@return temperature value in Celsius
*/
float fahrenheit2celsius(float fahrenheit);
/** Convert Kilometers per hour (kph) to Miles per hour (mph).
@param kph speed in Kilometers per hour
@return speed in miles per hour
*/
float kmph2mph(float kph);
/** Convert Miles per hour (mph) to Kilometers per hour (kmph).
@param mph speed in Kilometers per hour
@return speed in kilometers per hour
*/
float mph2kmph(float mph);
/** Convert millimeters (mm) to inches (inch).
@param mm measurement in millimeters
@return measurement in inches
*/
float mm2inch(float mm);
/** Convert inches (inch) to millimeters (mm).
@param inch measurement in inches
@return measurement in millimeters
*/
float inch2mm(float inch);
/** Convert kilo Pascal (kPa) to pounds per square inch (PSI).
@param kpa pressure in kPa
@return pressure in PSI
*/
float kpa2psi(float kpa);
/** Convert pounds per square inch (PSI) to kilo Pascal (kPa).
@param psi pressure in PSI
@return pressure in kPa
*/
float psi2kpa(float psi);
/** Convert hecto Pascal (hPa) to inches of mercury (inHg).
@param hpa pressure in kPa
@return pressure in inHg
*/
float hpa2inhg(float hpa);
/** Convert inches of mercury (inHg) to hecto Pascal (hPa).
@param inhg pressure in inHg
@return pressure in hPa
*/
float inhg2hpa(float inhg);
/** Return true if the string ends with the specified suffix, otherwise return false.
@param str string to search for patterns
@param suffix the pattern to search
@return true if the string ends with the specified suffix, false otherwise.
*/
bool str_endswith(char const *restrict str, char const *restrict suffix);
/** Replace a pattern in a string.
This utility function is useful when converting native units to si or customary.
@param orig string to search for patterns
@param rep the pattern to replace
@param with the replacement pattern
@return a new string that has rep replaced with with
*/
char *str_replace(char const *orig, char const *rep, char const *with);
/** Make a nice printable string for a frequency.
@param freq the frequency to convert to a string.
*/
char const *nice_freq (double freq);
#endif /* INCLUDE_R_UTIL_H_ */
|
