-
Notifications
You must be signed in to change notification settings - Fork 0
/
knot_protocol.c
279 lines (232 loc) · 7.94 KB
/
knot_protocol.c
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
/*
* Copyright (c) 2016, CESAR.
* All rights reserved.
*
* This software may be modified and distributed under the terms
* of the BSD license. See the LICENSE file for details.
*
*/
#include <stdint.h>
#include <errno.h>
#include "knot_types.h"
#include "knot_protocol.h"
/* Bitmask to identify used unit */
#define UNIT_MASK(unit) (1 << (unit))
#define UNIT_VOLTAGE_MASK (UNIT_MASK(KNOT_UNIT_VOLTAGE_V) | \
UNIT_MASK(KNOT_UNIT_VOLTAGE_MV) | \
UNIT_MASK(KNOT_UNIT_VOLTAGE_KV))
#define UNIT_CURRENT_MASK (UNIT_MASK(KNOT_UNIT_CURRENT_A) | \
UNIT_MASK(KNOT_UNIT_CURRENT_MA))
#define UNIT_RESISTENCE_MASK (UNIT_MASK(KNOT_UNIT_RESISTENCE_OHM))
#define UNIT_POWER_MASK (UNIT_MASK(KNOT_UNIT_POWER_W) | \
UNIT_MASK( KNOT_UNIT_POWER_KW) | \
UNIT_MASK(KNOT_UNIT_POWER_MW))
#define UNIT_TEMP_MASK (UNIT_MASK(KNOT_UNIT_TEMPERATURE_C) | \
UNIT_MASK(KNOT_UNIT_TEMPERATURE_F) | \
UNIT_MASK(KNOT_UNIT_TEMPERATURE_K))
#define UNIT_HUM_MASK (UNIT_MASK(KNOT_UNIT_RELATIVE_HUMIDITY))
#define UNIT_LUM_MASK (UNIT_MASK(KNOT_UNIT_LUMINOSITY_LM) | \
UNIT_MASK(KNOT_UNIT_LUMINOSITY_CD) | \
UNIT_MASK(KNOT_UNIT_LUMINOSITY_LX))
#define UNIT_TIME_MASK (UNIT_MASK(KNOT_UNIT_TIME_S) | \
UNIT_MASK(KNOT_UNIT_TIME_MS) | \
UNIT_MASK(KNOT_UNIT_TIME_US))
#define UNIT_MASS_MASK (UNIT_MASK(KNOT_UNIT_MASS_KG) | \
UNIT_MASK(KNOT_UNIT_MASS_G) | \
UNIT_MASK(KNOT_UNIT_MASS_LB) | \
UNIT_MASK(KNOT_UNIT_MASS_OZ))
#define UNIT_PRESSURE_MASK (UNIT_MASK(KNOT_UNIT_PRESSURE_PA) | \
UNIT_MASK(KNOT_UNIT_PRESSURE_PSI) | \
UNIT_MASK(KNOT_UNIT_PRESSURE_BAR))
#define UNIT_DISTANCE_MASK (UNIT_MASK(KNOT_UNIT_DISTANCE_M) | \
UNIT_MASK(KNOT_UNIT_DISTANCE_CM) | \
UNIT_MASK(KNOT_UNIT_DISTANCE_MI) | \
UNIT_MASK(KNOT_UNIT_DISTANCE_IN))
#define UNIT_ANGLE_MASK (UNIT_MASK(KNOT_UNIT_ANGLE_RAD) | \
UNIT_MASK(KNOT_UNIT_ANGLE_DEGREE))
#define UNIT_VOL_MASK (UNIT_MASK(KNOT_UNIT_VOLUME_L) | \
UNIT_MASK(KNOT_UNIT_VOLUME_ML) | \
UNIT_MASK(KNOT_UNIT_VOLUME_FLOZ) | \
UNIT_MASK(KNOT_UNIT_VOLUME_GAL))
#define UNIT_AREA_MASK (UNIT_MASK(KNOT_UNIT_AREA_M2) | \
UNIT_MASK(KNOT_UNIT_AREA_HA) | \
UNIT_MASK(KNOT_UNIT_AREA_AC))
#define UNIT_RAIN_MASK (UNIT_MASK(KNOT_UNIT_RAIN_MM))
#define UNIT_DENSITY_MASK (UNIT_MASK(KNOT_UNIT_DENSITY_KGM3))
#define UNIT_LAT_MASK (UNIT_MASK(KNOT_UNIT_LATITUDE_DEGREE))
#define UNIT_LONG_MASK (UNIT_MASK(KNOT_UNIT_LONGITUDE_DEGREE))
#define UNIT_SPEED_MASK (UNIT_MASK(KNOT_UNIT_SPEED_MS) | \
UNIT_MASK(KNOT_UNIT_SPEED_CMS) | \
UNIT_MASK(KNOT_UNIT_SPEED_KMH) | \
UNIT_MASK(KNOT_UNIT_SPEED_MIH))
#define UNIT_VOLFLOW_MASK (UNIT_MASK(KNOT_UNIT_VOLUMEFLOW_M3S) | \
UNIT_MASK(KNOT_UNIT_VOLUMEFLOW_SCMM) | \
UNIT_MASK(KNOT_UNIT_VOLUMEFLOW_LS) | \
UNIT_MASK(KNOT_UNIT_VOLUMEFLOW_LM) | \
UNIT_MASK(KNOT_UNIT_VOLUMEFLOW_FT3S) | \
UNIT_MASK(KNOT_UNIT_VOLUMEFLOW_GALM))
#define UNIT_ENERGY_MASK (UNIT_MASK(KNOT_UNIT_ENERGY_J) | \
UNIT_MASK(KNOT_UNIT_ENERGY_NM) | \
UNIT_MASK(KNOT_UNIT_ENERGY_WH) | \
UNIT_MASK(KNOT_UNIT_ENERGY_KWH) | \
UNIT_MASK(KNOT_UNIT_ENERGY_CAL) | \
UNIT_MASK(KNOT_UNIT_ENERGY_KCAL))
#define TYPE_ID_MASK(type) (type & 0x000F)
static const struct schema {
uint8_t value_type;
uint32_t unit_mask;
} basic_types[] = {
{KNOT_VALUE_TYPE_RAW, 0xFFFF },
{KNOT_VALUE_TYPE_INT, UNIT_VOLTAGE_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_CURRENT_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_RESISTENCE_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_POWER_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_TEMP_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_HUM_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_LUM_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_TIME_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_MASS_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_PRESSURE_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_DISTANCE_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_ANGLE_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_VOL_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_AREA_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_RAIN_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_DENSITY_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_LAT_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_LONG_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_SPEED_MASK },
{KNOT_VALUE_TYPE_FLOAT, UNIT_VOLFLOW_MASK },
{KNOT_VALUE_TYPE_INT, UNIT_ENERGY_MASK }
};
static const uint8_t logic_types[] = {
KNOT_VALUE_TYPE_BOOL, // KNOT_TYPE_ID_PRESENCE
KNOT_VALUE_TYPE_BOOL, // KNOT_TYPE_ID_SWITCH
KNOT_VALUE_TYPE_RAW // KNOT_TYPE_ID_COMMAND
};
static const uint8_t generic_types[] = {
KNOT_VALUE_TYPE_INT // KNOT_TYPE_ID_ANALOG
};
int knot_value_type_is_valid(uint8_t type)
{
if (type >= KNOT_VALUE_TYPE_MIN || type < KNOT_VALUE_TYPE_MAX)
return 0;
return KNOT_ERR_INVALID;
}
int knot_type_id_is_basic(uint16_t type_id)
{
if (type_id < KNOT_TYPE_ID_BASIC_MAX)
return 0;
return KNOT_ERR_INVALID;
}
int knot_type_id_is_logic(uint16_t type_id)
{
if (type_id >= KNOT_TYPE_ID_LOGIC_MIN &&
type_id < KNOT_TYPE_ID_LOGIC_MAX)
return 0;
return KNOT_ERR_INVALID;
}
int knot_type_id_is_generic(uint16_t type_id)
{
if (type_id >= KNOT_TYPE_ID_GENERIC_MIN &&
type_id < KNOT_TYPE_ID_GENERIC_MAX)
return 0;
return KNOT_ERR_INVALID;
}
int knot_schema_is_valid(uint16_t type_id, uint8_t value_type, uint8_t unit)
{
/* int/float/bool/raw ? */
if (knot_value_type_is_valid(value_type) == 0) {
/* Verify basic type IDs */
if (knot_type_id_is_basic(type_id) == 0) {
if (basic_types[type_id].value_type == value_type &&
basic_types[type_id].unit_mask & UNIT_MASK(unit))
return 0;
/* Verify logic type IDs */
} else if (knot_type_id_is_logic(type_id) == 0) {
if (logic_types[TYPE_ID_MASK(type_id)] == value_type)
return 0;
} else if (knot_type_id_is_generic(type_id) == 0) {
if (generic_types[TYPE_ID_MASK(type_id)] == value_type)
return 0;
}
}
return KNOT_ERR_INVALID;
}
int knot_config_is_valid(uint8_t event_flags, uint8_t value_type,
uint16_t time_sec, const knot_value_type *lower_limit,
const knot_value_type *upper_limit)
{
/* Check if event_flags are valid */
if ((event_flags | KNOT_EVT_FLAG_NONE) &&
!(event_flags & KNOT_EVENT_FLAG_MAX))
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
/* Check consistency of time_sec */
if (event_flags & KNOT_EVT_FLAG_TIME) {
if (time_sec == 0)
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
} else {
if (time_sec > 0)
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
}
/* Check consistency of limits */
if (event_flags & KNOT_EVT_FLAG_LOWER_THRESHOLD &&
(!lower_limit ||
value_type == KNOT_VALUE_TYPE_BOOL ||
value_type == KNOT_VALUE_TYPE_RAW))
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
if (event_flags & KNOT_EVT_FLAG_UPPER_THRESHOLD &&
(!upper_limit ||
value_type == KNOT_VALUE_TYPE_BOOL ||
value_type == KNOT_VALUE_TYPE_RAW))
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
if ((event_flags & KNOT_EVT_FLAG_LOWER_THRESHOLD) &&
(event_flags & KNOT_EVT_FLAG_UPPER_THRESHOLD)) {
/* Event by limits is only available for int and float */
switch(value_type) {
case KNOT_VALUE_TYPE_INT:
if( (upper_limit->val_i - lower_limit->val_i) < 0)
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
break;
case KNOT_VALUE_TYPE_FLOAT:
if( (upper_limit->val_f - lower_limit->val_f) < 0)
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
break;
default:
/*
* TODO: DEFINE KNOT_CONFIG ERRORS IN PROTOCOL
* KNOT_INVALID_CONFIG in new protocol
*/
return KNOT_ERR_INVALID;
}
}
return 0;
}