Add flight number to telemetry stream.
[fw/altos] / ao-tools / lib / cc.h
1 /*
2  * Copyright © 2009 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #ifndef _CC_H_
19 #define _CC_H_
20
21 #include <stdio.h>
22 #include <stdint.h>
23
24 char *
25 cc_fullname (char *dir, char *file);
26
27 char *
28 cc_basename(char *file);
29
30 int
31 cc_mkdir(char *dir);
32
33 struct cc_usbdev {
34         char    *sys;
35         char    *tty;
36         char    *manufacturer;
37         char    *product;
38         int     serial; /* AltOS always uses simple integer serial numbers */
39         int     idProduct;
40         int     idVendor;
41 };
42
43 struct cc_usbdevs {
44         struct cc_usbdev        **dev;
45         int                     ndev;
46 };
47
48 void
49 cc_usbdevs_free(struct cc_usbdevs *usbdevs);
50
51 struct cc_usbdevs *
52 cc_usbdevs_scan(void);
53
54 char *
55 cc_usbdevs_find_by_arg(char *arg, char *default_product);
56
57 void
58 cc_set_log_dir(char *dir);
59
60 char *
61 cc_get_log_dir(void);
62
63 char *
64 cc_make_filename(int serial, char *ext);
65
66 /*
67  * For sequential data which are not evenly spaced
68  */
69
70 struct cc_timedataelt {
71         double  time;
72         double  value;
73 };
74
75 struct cc_timedata {
76         int                     num;
77         int                     size;
78         struct cc_timedataelt   *data;
79         double                  time_offset;
80 };
81
82
83 /*
84  * For GPS data
85  */
86
87 struct cc_gpselt {
88         double          time;
89         double          lat;
90         double          lon;
91         double          alt;
92 };
93
94 #define SIRF_SAT_STATE_ACQUIRED                 (1 << 0)
95 #define SIRF_SAT_STATE_CARRIER_PHASE_VALID      (1 << 1)
96 #define SIRF_SAT_BIT_SYNC_COMPLETE              (1 << 2)
97 #define SIRF_SAT_SUBFRAME_SYNC_COMPLETE         (1 << 3)
98 #define SIRF_SAT_CARRIER_PULLIN_COMPLETE        (1 << 4)
99 #define SIRF_SAT_CODE_LOCKED                    (1 << 5)
100 #define SIRF_SAT_ACQUISITION_FAILED             (1 << 6)
101 #define SIRF_SAT_EPHEMERIS_AVAILABLE            (1 << 7)
102
103 struct cc_gpssat {
104         double          time;
105         uint16_t        svid;
106         uint8_t         state;
107         uint8_t         c_n;
108 };
109
110 struct cc_gpssats {
111         int                     nsat;
112         struct cc_gpssat        sat[12];
113 };
114
115 struct cc_gpsdata {
116         int                     num;
117         int                     size;
118         struct cc_gpselt        *data;
119         double                  time_offset;
120         int                     numsats;
121         int                     sizesats;
122         struct cc_gpssats       *sats;
123 };
124
125 /*
126  * For sequential data which are evenly spaced
127  */
128 struct cc_perioddata {
129         int             num;
130         double          start;
131         double          step;
132         double          *data;
133 };
134
135 enum ao_flight_state {
136         ao_flight_startup = 0,
137         ao_flight_idle = 1,
138         ao_flight_pad = 2,
139         ao_flight_boost = 3,
140         ao_flight_fast = 4,
141         ao_flight_coast = 5,
142         ao_flight_drogue = 6,
143         ao_flight_main = 7,
144         ao_flight_landed = 8,
145         ao_flight_invalid = 9
146 };
147
148 struct cc_flightraw {
149         int                     flight;
150         int                     serial;
151         double                  ground_accel;
152         double                  ground_pres;
153         struct cc_timedata      accel;
154         struct cc_timedata      pres;
155         struct cc_timedata      temp;
156         struct cc_timedata      volt;
157         struct cc_timedata      main;
158         struct cc_timedata      drogue;
159         struct cc_timedata      state;
160         struct cc_gpsdata       gps;
161 };
162
163 struct cc_flightraw *
164 cc_log_read(FILE *file);
165
166 void
167 cc_flightraw_free(struct cc_flightraw *raw);
168
169 struct cc_flightcooked {
170         double                  flight_start;
171         double                  flight_stop;
172
173         struct cc_perioddata    accel_accel;
174         struct cc_perioddata    accel_speed;
175         struct cc_perioddata    accel_pos;
176         struct cc_perioddata    pres_pos;
177         struct cc_perioddata    pres_speed;
178         struct cc_perioddata    pres_accel;
179         struct cc_perioddata    gps_lat;
180         struct cc_perioddata    gps_lon;
181         struct cc_perioddata    gps_alt;
182
183         /* unfiltered, but converted */
184         struct cc_timedata      pres;
185         struct cc_timedata      accel;
186         struct cc_timedata      state;
187 };
188
189 /*
190  * Telemetry data contents
191  */
192
193
194 struct cc_gps_time {
195         int hour;
196         int minute;
197         int second;
198 };
199
200 struct cc_gps {
201         int     nsat;
202         int     gps_locked;
203         int     gps_connected;
204         struct cc_gps_time gps_time;
205         double  lat;            /* degrees (+N -S) */
206         double  lon;            /* degrees (+E -W) */
207         int     alt;            /* m */
208
209         int     gps_extended;   /* has extra data */
210         double  ground_speed;   /* m/s */
211         int     course;         /* degrees */
212         double  climb_rate;     /* m/s */
213         double  hdop;           /* unitless? */
214         int     h_error;        /* m */
215         int     v_error;        /* m */
216 };
217
218 #define SIRF_SAT_STATE_ACQUIRED                 (1 << 0)
219 #define SIRF_SAT_STATE_CARRIER_PHASE_VALID      (1 << 1)
220 #define SIRF_SAT_BIT_SYNC_COMPLETE              (1 << 2)
221 #define SIRF_SAT_SUBFRAME_SYNC_COMPLETE         (1 << 3)
222 #define SIRF_SAT_CARRIER_PULLIN_COMPLETE        (1 << 4)
223 #define SIRF_SAT_CODE_LOCKED                    (1 << 5)
224 #define SIRF_SAT_ACQUISITION_FAILED             (1 << 6)
225 #define SIRF_SAT_EPHEMERIS_AVAILABLE            (1 << 7)
226
227 struct cc_gps_sat {
228         int     svid;
229         int     state;
230         int     c_n0;
231 };
232
233 struct cc_gps_tracking {
234         int                     channels;
235         struct cc_gps_sat       sats[12];
236 };
237
238 struct cc_telem {
239         char    callsign[16];
240         int     serial;
241         int     flight;
242         int     rssi;
243         char    state[16];
244         int     tick;
245         int     accel;
246         int     pres;
247         int     temp;
248         int     batt;
249         int     drogue;
250         int     main;
251         int     flight_accel;
252         int     ground_accel;
253         int     flight_vel;
254         int     flight_pres;
255         int     ground_pres;
256         int     accel_plus_g;
257         int     accel_minus_g;
258         struct cc_gps   gps;
259         struct cc_gps_tracking  gps_tracking;
260 };
261
262 int
263 cc_telem_parse(const char *input_line, struct cc_telem *telem);
264
265 #ifndef TRUE
266 #define TRUE 1
267 #define FALSE 0
268 #endif
269
270 /* Conversion functions */
271 double
272 cc_pressure_to_altitude(double pressure);
273
274 double
275 cc_altitude_to_pressure(double altitude);
276
277 double
278 cc_barometer_to_pressure(double baro);
279
280 double
281 cc_barometer_to_altitude(double baro);
282
283 double
284 cc_accelerometer_to_acceleration(double accel, double ground_accel);
285
286 double
287 cc_thermometer_to_temperature(double thermo);
288
289 double
290 cc_battery_to_voltage(double battery);
291
292 double
293 cc_ignitor_to_voltage(double ignite);
294
295 void
296 cc_great_circle (double start_lat, double start_lon,
297                  double end_lat, double end_lon,
298                  double *dist, double *bearing);
299
300 void
301 cc_timedata_limits(struct cc_timedata *d, double min_time, double max_time, int *start, int *stop);
302
303 int
304 cc_timedata_min(struct cc_timedata *d, double min_time, double max_time);
305
306 int
307 cc_timedata_min_mag(struct cc_timedata *d, double min_time, double max_time);
308
309 int
310 cc_timedata_max(struct cc_timedata *d, double min_time, double max_time);
311
312 int
313 cc_timedata_max_mag(struct cc_timedata *d, double min_time, double max_time);
314
315 double
316 cc_timedata_average(struct cc_timedata *d, double min_time, double max_time);
317
318 double
319 cc_timedata_average_mag(struct cc_timedata *d, double min_time, double max_time);
320
321 int
322 cc_perioddata_limits(struct cc_perioddata *d, double min_time, double max_time, int *start, int *stop);
323
324 int
325 cc_perioddata_min(struct cc_perioddata *d, double min_time, double max_time);
326
327 int
328 cc_perioddata_min_mag(struct cc_perioddata *d, double min_time, double max_time);
329
330 int
331 cc_perioddata_max(struct cc_perioddata *d, double min_time, double max_time);
332
333 int
334 cc_perioddata_max_mag(struct cc_perioddata *d, double min_time, double max_time);
335
336 double
337 cc_perioddata_average(struct cc_perioddata *d, double min_time, double max_time);
338
339 double
340 cc_perioddata_average_mag(struct cc_perioddata *d, double min_time, double max_time);
341
342 double *
343 cc_low_pass(double *data, int data_len, double omega_pass, double omega_stop, double error);
344
345 struct cc_perioddata *
346 cc_period_make(struct cc_timedata *td, double start_time, double stop_time);
347
348 struct cc_perioddata *
349 cc_period_low_pass(struct cc_perioddata *raw, double omega_pass, double omega_stop, double error);
350
351 struct cc_timedata *
352 cc_timedata_convert(struct cc_timedata *d, double (*f)(double v, double a), double a);
353
354 struct cc_timedata *
355 cc_timedata_integrate(struct cc_timedata *d, double min_time, double max_time);
356
357 struct cc_perioddata *
358 cc_perioddata_differentiate(struct cc_perioddata *i);
359
360 struct cc_flightcooked *
361 cc_flight_cook(struct cc_flightraw *raw);
362
363 void
364 cc_flightcooked_free(struct cc_flightcooked *cooked);
365
366 #endif /* _CC_H_ */