altoslib: Don't crash if there's no GPS coord to write KML
[fw/altos] / altoslib / AltosCalData.java
1 /*
2  * Copyright © 2017 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, either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  */
14
15 package org.altusmetrum.altoslib_12;
16
17 /*
18  * Calibration and other data needed to construct 'real' values from various data
19  * sources.
20  */
21
22 public class AltosCalData {
23         public int              flight = AltosLib.MISSING;
24
25         public void set_flight(int flight) {
26                 if (flight != AltosLib.MISSING)
27                         this.flight = flight;
28         }
29
30         public String           callsign = null;
31
32         public void set_callsign(String callsign) {
33                 if (callsign != null)
34                         this.callsign = callsign;
35         }
36
37         public String           firmware_version = null;
38
39         public void set_firmware_version(String firmware_version) {
40                 if (firmware_version != null)
41                         this.firmware_version = firmware_version;
42         }
43
44         public String           product = null;
45
46         public void set_product(String product) {
47                 if (product != null)
48                         this.product = product;
49         }
50
51         public int              serial = AltosLib.MISSING;
52
53         public void set_serial(int serial) {
54                 if (serial != AltosLib.MISSING)
55                         this.serial = serial;
56         }
57
58         public int              receiver_serial = AltosLib.MISSING;
59
60         public void set_receiver_serial(int receiver_serial) {
61                 if (receiver_serial != AltosLib.MISSING)
62                         this.receiver_serial = receiver_serial;
63         }
64
65         public int              device_type = AltosLib.MISSING;
66
67         public void set_device_type(int device_type) {
68                 if (device_type != AltosLib.MISSING) {
69                         this.device_type = device_type;
70                         if (product == null)
71                                 set_product(AltosLib.product_name(device_type));
72                 }
73         }
74
75         public int              log_format = AltosLib.MISSING;
76
77         public void set_log_format(int log_format) {
78                 if (log_format != AltosLib.MISSING)
79                         this.log_format = log_format;
80         }
81
82         public int              config_major = AltosLib.MISSING;
83         public int              config_minor = AltosLib.MISSING;
84         public int              flight_log_max = AltosLib.MISSING;
85
86         public void set_config(int major, int minor, int log_max) {
87                 if (major != AltosLib.MISSING)
88                         config_major = major;
89                 if (minor != AltosLib.MISSING)
90                         config_minor = minor;
91                 if (log_max != AltosLib.MISSING)
92                         flight_log_max = log_max;
93         }
94
95         public double           apogee_delay = AltosLib.MISSING;
96         public double           main_deploy = AltosLib.MISSING;
97
98         public void set_flight_params(double apogee_delay, double main_deploy) {
99                 if (apogee_delay != AltosLib.MISSING)
100                         this.apogee_delay = apogee_delay;
101                 if (main_deploy != AltosLib.MISSING)
102                         this.main_deploy = main_deploy;
103         }
104
105         public double           accel_plus_g = AltosLib.MISSING;
106         public double           accel_minus_g = AltosLib.MISSING;
107         public double           ground_accel = AltosLib.MISSING;
108
109         public void set_accel_plus_minus(double plus, double minus) {
110                 if (plus != AltosLib.MISSING && minus != AltosLib.MISSING) {
111                         if (plus == minus)
112                                 return;
113                         accel_plus_g = plus;
114                         accel_minus_g = minus;
115                 }
116         }
117
118         public void set_ground_accel(double ground_accel) {
119                 if (ground_accel != AltosLib.MISSING)
120                         this.ground_accel = ground_accel;
121         }
122
123         /* Raw acceleration value */
124         public double           accel = AltosLib.MISSING;
125
126         public void set_accel(double accel) {
127                 this.accel = accel;
128         }
129
130         public boolean mma655x_inverted = false;
131
132         public void set_mma655x_inverted(boolean inverted) {
133                 mma655x_inverted = inverted;
134         }
135
136         public int pad_orientation = AltosLib.MISSING;
137
138         public void set_pad_orientation(int orientation) {
139                 if (orientation != AltosLib.MISSING)
140                         pad_orientation = orientation;
141         }
142
143         /* Compute acceleration */
144         public double acceleration(double sensor) {
145                 return AltosConvert.acceleration_from_sensor(sensor, accel_plus_g, accel_minus_g, ground_accel);
146         }
147
148         public AltosMs5607      ms5607 = null;
149
150         public void set_ms5607(AltosMs5607 ms5607) {
151                 this.ms5607 = ms5607;
152         }
153
154         public double           ground_pressure = AltosLib.MISSING;
155         public double           ground_altitude = AltosLib.MISSING;
156
157         public void set_ground_pressure(double ground_pressure) {
158                 if (ground_pressure != AltosLib.MISSING) {
159                         this.ground_pressure = ground_pressure;
160                         this.ground_altitude = AltosConvert.pressure_to_altitude(ground_pressure);
161                 }
162         }
163
164         public void set_ground_altitude(double ground_altitude) {
165                 if (ground_altitude != AltosLib.MISSING)
166                         this.ground_altitude = ground_altitude;
167         }
168
169         /* Compute pressure */
170
171         public AltosPresTemp pressure_ms5607(int raw_pres, int raw_temp) {
172                 if (ms5607 == null)
173                         return new AltosPresTemp(AltosLib.MISSING, AltosLib.MISSING);
174                 return ms5607.pres_temp(raw_pres, raw_temp);
175         }
176
177         public int              tick = AltosLib.MISSING;
178         private int             first_tick = AltosLib.MISSING;
179         private int             prev_tick = AltosLib.MISSING;
180
181         public void set_tick(int tick) {
182                 if (tick != AltosLib.MISSING) {
183                         if (prev_tick != AltosLib.MISSING) {
184                                 while (tick < prev_tick - 1000) {
185                                         tick += 65536;
186                                 }
187                         }
188                         if (first_tick == AltosLib.MISSING)
189                                 first_tick = tick;
190                         prev_tick = tick;
191                         this.tick = tick;
192                 }
193         }
194
195         /* Reset all values which change during flight
196          */
197         public void reset() {
198                 state = AltosLib.MISSING;
199                 tick = AltosLib.MISSING;
200                 prev_tick = AltosLib.MISSING;
201                 temp_gps = null;
202                 prev_gps = null;
203                 temp_gps_sat_tick = AltosLib.MISSING;
204                 accel = AltosLib.MISSING;
205         }
206
207         public int              boost_tick = AltosLib.MISSING;
208
209         public void set_boost_tick() {
210                 boost_tick = tick;
211         }
212
213         public double           ticks_per_sec = 100.0;
214
215         public void set_ticks_per_sec(double ticks_per_sec) {
216                 this.ticks_per_sec = ticks_per_sec;
217         }
218
219         public double time() {
220                 if (tick == AltosLib.MISSING)
221                         return AltosLib.MISSING;
222                 if (boost_tick != AltosLib.MISSING)
223                         return (tick - boost_tick) / ticks_per_sec;
224                 if (first_tick != AltosLib.MISSING)
225                         return (tick - first_tick) / ticks_per_sec;
226                 return tick / ticks_per_sec;
227         }
228
229         public double boost_time() {
230                 if (boost_tick == AltosLib.MISSING)
231                         return AltosLib.MISSING;
232                 return boost_tick / ticks_per_sec;
233         }
234
235         public int              state = AltosLib.MISSING;
236
237         public void set_state(int state) {
238                 if (state >= AltosLib.ao_flight_boost && boost_tick == AltosLib.MISSING)
239                         set_boost_tick();
240                 this.state = state;
241         }
242
243         public AltosGPS         gps_pad = null;
244
245         public double           gps_pad_altitude = AltosLib.MISSING;
246
247         public void set_gps(AltosGPS gps) {
248                 if ((state != AltosLib.MISSING && state < AltosLib.ao_flight_boost) || gps_pad == null)
249                         gps_pad = gps;
250                 if (gps_pad_altitude == AltosLib.MISSING && gps.alt != AltosLib.MISSING)
251                         gps_pad_altitude = gps.alt;
252         }
253
254         /*
255          * While receiving GPS data, we construct a temporary GPS state
256          * object and then deliver the result atomically to the listener
257          */
258         AltosGPS                temp_gps = null;
259         AltosGPS                prev_gps = null;
260         int                     temp_gps_sat_tick = AltosLib.MISSING;
261
262         public AltosGPS temp_gps() {
263                 return temp_gps;
264         }
265
266         public void reset_temp_gps() {
267                 if (temp_gps != null) {
268                         if (temp_gps.locked && temp_gps.nsat >= 4)
269                                 set_gps(temp_gps);
270                         prev_gps = temp_gps;
271                         temp_gps = null;
272                 }
273         }
274
275         public boolean gps_pending() {
276                 return temp_gps != null;
277         }
278
279         public AltosGPS make_temp_gps(int tick, boolean sats) {
280                 if (temp_gps == null) {
281                         if (prev_gps != null)
282                                 temp_gps = prev_gps.clone();
283                         else
284                                 temp_gps = new AltosGPS();
285                 }
286                 if (sats) {
287                         if (tick != temp_gps_sat_tick)
288                                 temp_gps.cc_gps_sat = null;
289                         temp_gps_sat_tick = tick;
290                 }
291                 return temp_gps;
292         }
293
294         public double   accel_zero_along, accel_zero_across, accel_zero_through;
295
296         public void set_accel_zero(double zero_along, double zero_across, double zero_through) {
297                 if (zero_along != AltosLib.MISSING) {
298                         accel_zero_along = zero_along;
299                         accel_zero_across = zero_across;
300                         accel_zero_through = zero_through;
301                 }
302         }
303
304         public double accel_along(double counts) {
305                 return AltosIMU.convert_accel(counts - accel_zero_along);
306         }
307
308         public double accel_across(double counts) {
309                 return AltosIMU.convert_accel(counts - accel_zero_across);
310         }
311
312         public double accel_through(double counts) {
313                 return AltosIMU.convert_accel(counts - accel_zero_through);
314         }
315
316         public double   gyro_zero_roll, gyro_zero_pitch, gyro_zero_yaw;
317
318         public void set_gyro_zero(double roll, double pitch, double yaw) {
319                 if (roll != AltosLib.MISSING) {
320                         gyro_zero_roll = roll;
321                         gyro_zero_pitch = pitch;
322                         gyro_zero_yaw = yaw;
323                         imu_wrap_checked = false;
324                 }
325         }
326
327         public double gyro_roll(double counts) {
328                 if (gyro_zero_roll == AltosLib.MISSING || counts == AltosLib.MISSING)
329                         return AltosLib.MISSING;
330
331                 return AltosIMU.gyro_degrees_per_second(counts, gyro_zero_roll);
332         }
333
334         public double gyro_pitch(double counts) {
335                 if (gyro_zero_pitch == AltosLib.MISSING || counts == AltosLib.MISSING)
336                         return AltosLib.MISSING;
337                 return AltosIMU.gyro_degrees_per_second(counts, gyro_zero_pitch);
338         }
339
340         public double gyro_yaw(double counts) {
341                 if (gyro_zero_yaw == AltosLib.MISSING || counts == AltosLib.MISSING)
342                         return AltosLib.MISSING;
343                 return AltosIMU.gyro_degrees_per_second(counts, gyro_zero_yaw);
344         }
345
346         private double gyro_zero_overflow(double first) {
347                 double v = first / 128.0;
348                 if (v < 0)
349                         v = Math.ceil(v);
350                 else
351                         v = Math.floor(v);
352 //              if (v != 0)
353 //                      System.out.printf("Adjusting gyro axis by %g steps\n", v);
354                 return v * 128.0;
355         }
356
357         /* Initial TeleMega log format had only 16 bits for gyro cal, so the top 9 bits got lost as the
358          * cal data are scaled by 512. Use the first sample to adjust the cal value, assuming that it is
359          * from a time of fairly low rotation speed. Fixed in later TeleMega firmware by storing 32 bits
360          * of cal values.
361          */
362         private boolean imu_wrap_checked = false;
363
364         public void check_imu_wrap(double roll, double pitch, double yaw) {
365                 if (!imu_wrap_checked) {
366                         gyro_zero_roll += gyro_zero_overflow(roll);
367                         gyro_zero_pitch += gyro_zero_overflow(pitch);
368                         gyro_zero_yaw += gyro_zero_overflow(yaw);
369                         imu_wrap_checked = true;
370                 }
371         }
372
373         public double mag_along(double along) {
374                 if (along == AltosLib.MISSING)
375                         return AltosLib.MISSING;
376                 return AltosMag.convert_gauss(along);
377         }
378
379         public double mag_across(double across) {
380                 if (across == AltosLib.MISSING)
381                         return AltosLib.MISSING;
382                 return AltosMag.convert_gauss(across);
383         }
384
385         public double mag_through(double through) {
386                 if (through == AltosLib.MISSING)
387                         return AltosLib.MISSING;
388                 return AltosMag.convert_gauss(through);
389         }
390
391         public AltosCalData() {
392         }
393
394         public AltosCalData(AltosConfigData config_data) {
395                 set_serial(config_data.serial);
396                 set_ticks_per_sec(100.0);
397                 set_flight(config_data.flight);
398                 set_callsign(config_data.callsign);
399                 set_config(config_data.config_major, config_data.config_minor, config_data.flight_log_max);
400                 set_firmware_version(config_data.version);
401                 set_flight_params(config_data.apogee_delay / ticks_per_sec, config_data.apogee_lockout / ticks_per_sec);
402                 set_pad_orientation(config_data.pad_orientation);
403                 set_product(config_data.product);
404                 set_accel_plus_minus(config_data.accel_cal_plus, config_data.accel_cal_minus);
405                 set_accel_zero(config_data.accel_zero_along, config_data.accel_zero_across, config_data.accel_zero_through);
406                 set_ms5607(config_data.ms5607);
407                 try {
408                         set_mma655x_inverted(config_data.mma655x_inverted());
409                 } catch (AltosUnknownProduct up) {
410                 }
411                 set_pad_orientation(config_data.pad_orientation);
412         }
413 }