Add DSP code to filter data, allowing for integration/differentiation
[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
23 char *
24 cc_fullname (char *dir, char *file);
25
26 char *
27 cc_basename(char *file);
28
29 int
30 cc_mkdir(char *dir);
31
32 struct cc_usbdev {
33         char    *sys;
34         char    *tty;
35         char    *manufacturer;
36         char    *product;
37         int     serial; /* AltOS always uses simple integer serial numbers */
38         int     idProduct;
39         int     idVendor;
40 };
41
42 struct cc_usbdevs {
43         struct cc_usbdev        **dev;
44         int                     ndev;
45 };
46
47 void
48 cc_usbdevs_free(struct cc_usbdevs *usbdevs);
49
50 struct cc_usbdevs *
51 cc_usbdevs_scan(void);
52
53 char *
54 cc_usbdevs_find_by_arg(char *arg, char *default_product);
55
56 void
57 cc_set_log_dir(char *dir);
58
59 char *
60 cc_get_log_dir(void);
61
62 char *
63 cc_make_filename(int serial, char *ext);
64
65 /*
66  * For sequential data which are not evenly spaced
67  */
68
69 struct cc_timedataelt {
70         double  time;
71         double  value;
72 };
73
74 struct cc_timedata {
75         int                     num;
76         int                     size;
77         struct cc_timedataelt   *data;
78         double                  time_offset;
79 };
80
81
82 /*
83  * For GPS data
84  */
85
86 struct cc_gpselt {
87         double          time;
88         double          lat;
89         double          lon;
90         double          alt;
91 };
92
93 struct cc_gpsdata {
94         int                     num;
95         int                     size;
96         struct cc_gpselt        *data;
97         double                  time_offset;
98 };
99
100 /*
101  * For sequential data which are evenly spaced
102  */
103 struct cc_perioddata {
104         int             num;
105         double          start;
106         double          step;
107         double          *data;
108 };
109
110 enum ao_flight_state {
111         ao_flight_startup = 0,
112         ao_flight_idle = 1,
113         ao_flight_pad = 2,
114         ao_flight_boost = 3,
115         ao_flight_fast = 4,
116         ao_flight_coast = 5,
117         ao_flight_drogue = 6,
118         ao_flight_main = 7,
119         ao_flight_landed = 8,
120         ao_flight_invalid = 9
121 };
122
123 struct cc_flightraw {
124         int                     flight;
125         int                     serial;
126         double                  ground_accel;
127         double                  ground_pres;
128         struct cc_timedata      accel;
129         struct cc_timedata      pres;
130         struct cc_timedata      temp;
131         struct cc_timedata      volt;
132         struct cc_timedata      main;
133         struct cc_timedata      drogue;
134         struct cc_timedata      state;
135         struct cc_gpsdata       gps;
136 };
137
138 struct cc_flightraw *
139 cc_log_read(FILE *file);
140
141 void
142 cc_flightraw_free(struct cc_flightraw *raw);
143
144 struct cc_flightcooked {
145         struct cc_perioddata    accel_accel;
146         struct cc_perioddata    accel_speed;
147         struct cc_perioddata    accel_pos;
148         struct cc_perioddata    pres_pos;
149         struct cc_perioddata    pres_speed;
150         struct cc_perioddata    pres_accel;
151         struct cc_perioddata    gps_lat;
152         struct cc_perioddata    gps_lon;
153         struct cc_perioddata    gps_alt;
154         struct cc_timedata      state;
155 };
156
157 /*
158  * Telemetry data contents
159  */
160
161
162 struct cc_gps_time {
163         int hour;
164         int minute;
165         int second;
166 };
167
168 struct cc_gps {
169         int     nsat;
170         int     gps_locked;
171         int     gps_connected;
172         struct cc_gps_time gps_time;
173         double  lat;            /* degrees (+N -S) */
174         double  lon;            /* degrees (+E -W) */
175         int     alt;            /* m */
176
177         int     gps_extended;   /* has extra data */
178         double  ground_speed;   /* m/s */
179         int     course;         /* degrees */
180         double  climb_rate;     /* m/s */
181         double  hdop;           /* unitless? */
182         int     h_error;        /* m */
183         int     v_error;        /* m */
184 };
185
186 #define SIRF_SAT_STATE_ACQUIRED                 (1 << 0)
187 #define SIRF_SAT_STATE_CARRIER_PHASE_VALID      (1 << 1)
188 #define SIRF_SAT_BIT_SYNC_COMPLETE              (1 << 2)
189 #define SIRF_SAT_SUBFRAME_SYNC_COMPLETE         (1 << 3)
190 #define SIRF_SAT_CARRIER_PULLIN_COMPLETE        (1 << 4)
191 #define SIRF_SAT_CODE_LOCKED                    (1 << 5)
192 #define SIRF_SAT_ACQUISITION_FAILED             (1 << 6)
193 #define SIRF_SAT_EPHEMERIS_AVAILABLE            (1 << 7)
194
195 struct cc_gps_sat {
196         int     svid;
197         int     state;
198         int     c_n0;
199 };
200
201 struct cc_gps_tracking {
202         int                     channels;
203         struct cc_gps_sat       sats[12];
204 };
205
206 struct cc_telem {
207         char    callsign[16];
208         int     serial;
209         int     rssi;
210         char    state[16];
211         int     tick;
212         int     accel;
213         int     pres;
214         int     temp;
215         int     batt;
216         int     drogue;
217         int     main;
218         int     flight_accel;
219         int     ground_accel;
220         int     flight_vel;
221         int     flight_pres;
222         int     ground_pres;
223         struct cc_gps   gps;
224         struct cc_gps_tracking  gps_tracking;
225 };
226
227 int
228 cc_telem_parse(const char *input_line, struct cc_telem *telem);
229
230 #ifndef TRUE
231 #define TRUE 1
232 #define FALSE 0
233 #endif
234
235 /* Conversion functions */
236 double
237 cc_pressure_to_altitude(double pressure);
238
239 double
240 cc_altitude_to_pressure(double altitude);
241
242 double
243 cc_barometer_to_pressure(double baro);
244
245 double
246 cc_barometer_to_altitude(double baro);
247
248 double
249 cc_accelerometer_to_acceleration(double accel, double ground_accel);
250
251 double
252 cc_thermometer_to_temperature(double thermo);
253
254 double
255 cc_battery_to_voltage(double battery);
256
257 double
258 cc_ignitor_to_voltage(double ignite);
259
260 void
261 cc_great_circle (double start_lat, double start_lon,
262                  double end_lat, double end_lon,
263                  double *dist, double *bearing);
264
265 int
266 cc_timedata_min(struct cc_timedata *d, double min_time, double max_time);
267
268 int
269 cc_timedata_max(struct cc_timedata *d, double min_time, double max_time);
270
271 int
272 cc_perioddata_min(struct cc_perioddata *d, double min_time, double max_time);
273
274 int
275 cc_perioddata_max(struct cc_perioddata *d, double min_time, double max_time);
276
277 double *
278 cc_low_pass(double *data, int data_len, double omega_pass, double omega_stop, double error);
279
280 struct cc_perioddata *
281 cc_period_make(struct cc_timedata *td, double start_time, double stop_time);
282
283 struct cc_perioddata *
284 cc_period_low_pass(struct cc_perioddata *raw, double omega_pass, double omega_stop, double error);
285
286 struct cc_timedata *
287 cc_timedata_convert(struct cc_timedata *d, double (*f)(double v, double a), double a);
288
289 struct cc_timedata *
290 cc_timedata_integrate(struct cc_timedata *d);
291
292 struct cc_perioddata *
293 cc_perioddata_differentiate(struct cc_perioddata *i);
294
295 struct cc_flightcooked *
296 cc_flight_cook(struct cc_flightraw *raw);
297
298
299 #endif /* _CC_H_ */