altos/test: Adjust CRC error rate after FEC fix
[fw/altos] / altoslib / AltosLib.java
1 /*
2  * Copyright © 2010 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  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
17  */
18
19 package org.altusmetrum.altoslib_14;
20
21 import java.util.*;
22 import java.io.*;
23 import java.nio.charset.Charset;
24
25 public class AltosLib {
26         /* EEProm command letters */
27         public static final int AO_LOG_FLIGHT = 'F';
28         public static final int AO_LOG_SENSOR = 'A';
29         public static final int AO_LOG_TEMP_VOLT = 'T';
30         public static final int AO_LOG_DEPLOY = 'D';
31         public static final int AO_LOG_STATE = 'S';
32         public static final int AO_LOG_GPS_POS = 'P';
33         public static final int AO_LOG_GPS_TIME = 'G';
34         public static final int AO_LOG_GPS_LAT = 'N';
35         public static final int AO_LOG_GPS_LON = 'W';
36         public static final int AO_LOG_GPS_ALT = 'H';
37         public static final int AO_LOG_GPS_SAT = 'V';
38         public static final int AO_LOG_GPS_DATE = 'Y';
39         public static final int AO_LOG_PRESSURE = 'P';
40
41         public static boolean is_gps_cmd(int cmd) {
42                 switch (cmd) {
43                 case AltosLib.AO_LOG_GPS_POS:
44                 case AltosLib.AO_LOG_GPS_TIME:
45                 case AltosLib.AO_LOG_GPS_LAT:
46                 case AltosLib.AO_LOG_GPS_LON:
47                 case AltosLib.AO_LOG_GPS_ALT:
48                 case AltosLib.AO_LOG_GPS_SAT:
49                 case AltosLib.AO_LOG_GPS_DATE:
50                         return true;
51                 }
52                 return false;
53         }
54
55         /* Added for header fields in eeprom files */
56         public static final int AO_LOG_CONFIG_VERSION = 1000;
57         public static final int AO_LOG_MAIN_DEPLOY = 1001;
58         public static final int AO_LOG_APOGEE_DELAY = 1002;
59         public static final int AO_LOG_RADIO_CHANNEL = 1003;
60         public static final int AO_LOG_CALLSIGN = 1004;
61         public static final int AO_LOG_ACCEL_CAL = 1005;
62         public static final int AO_LOG_RADIO_CAL = 1006;
63         public static final int AO_LOG_MAX_FLIGHT_LOG = 1007;
64         public static final int AO_LOG_MANUFACTURER = 2000;
65         public static final int AO_LOG_PRODUCT = 2001;
66         public static final int AO_LOG_SERIAL_NUMBER = 2002;
67         public static final int AO_LOG_LOG_FORMAT = 2003;
68
69         public static final int AO_LOG_FREQUENCY = 2004;
70         public static final int AO_LOG_APOGEE_LOCKOUT = 2005;
71         public static final int AO_LOG_RADIO_RATE = 2006;
72         public static final int AO_LOG_IGNITE_MODE = 2007;
73         public static final int AO_LOG_PAD_ORIENTATION = 2008;
74         public static final int AO_LOG_RADIO_ENABLE = 2009;
75         public static final int AO_LOG_AES_KEY = 2010;
76         public static final int AO_LOG_APRS = 2011;
77         public static final int AO_LOG_BEEP_SETTING = 2012;
78         public static final int AO_LOG_TRACKER_SETTING = 2013;
79         public static final int AO_LOG_PYRO_TIME = 2014;
80         public static final int AO_LOG_APRS_ID = 2015;
81         public static final int AO_LOG_ALTITUDE_32 = 2016;
82
83         /* Added for header fields in telemega files */
84         public static final int AO_LOG_BARO_RESERVED = 3000;
85         public static final int AO_LOG_BARO_SENS = 3001;
86         public static final int AO_LOG_BARO_OFF = 3002;
87         public static final int AO_LOG_BARO_TCS = 3004;
88         public static final int AO_LOG_BARO_TCO = 3005;
89         public static final int AO_LOG_BARO_TREF = 3006;
90         public static final int AO_LOG_BARO_TEMPSENS = 3007;
91         public static final int AO_LOG_BARO_CRC = 3008;
92         public static final int AO_LOG_IMU_CAL = 3009;
93
94         public static final int AO_LOG_SOFTWARE_VERSION = 9999;
95
96         public final static int MISSING = 0x7fffffff;
97
98         /* Added to flag invalid records */
99         public static final int AO_LOG_INVALID = -1;
100
101         /* Flight state numbers and names */
102         public static final int ao_flight_startup = 0;
103         public static final int ao_flight_idle = 1;
104         public static final int ao_flight_pad = 2;
105         public static final int ao_flight_boost = 3;
106         public static final int ao_flight_fast = 4;
107         public static final int ao_flight_coast = 5;
108         public static final int ao_flight_drogue = 6;
109         public static final int ao_flight_main = 7;
110         public static final int ao_flight_landed = 8;
111         public static final int ao_flight_invalid = 9;
112         public static final int ao_flight_stateless = 10;
113
114         /* USB product IDs */
115         public final static int vendor_altusmetrum = 0xfffe;
116
117         public final static int product_altusmetrum = 0x000a;
118         public final static int product_telemetrum = 0x000b;
119         public final static int product_teledongle = 0x000c;
120         public final static int product_easytimer = 0x000d;
121         public final static int product_telebt = 0x000e;
122         public final static int product_telelaunch = 0x000f;
123         public final static int product_telelco = 0x0010;
124         public final static int product_telescience = 0x0011;
125         public final static int product_telepyro =0x0012;
126         public final static int product_telemega = 0x0023;
127         public final static int product_megadongle = 0x0024;
128         public final static int product_telegps = 0x0025;
129         public final static int product_easymini = 0x0026;
130         public final static int product_telemini = 0x0027;
131         public final static int product_easymega = 0x0028;
132         public final static int product_usbtrng = 0x0029;
133         public final static int product_usbrelay = 0x002a;
134         public final static int product_mpusb = 0x002b;
135         public final static int product_easymotor = 0x002c;
136         public final static int product_altusmetrum_min = 0x000a;
137         public final static int product_altusmetrum_max = 0x002c;
138
139         public final static int product_any = 0x10000;
140         public final static int product_basestation = 0x10000 + 1;
141         public final static int product_altimeter = 0x10000 + 2;
142
143         private static class Product {
144                 final String    name;
145                 final int       product;
146
147                 Product (String name, int product) {
148                         this.name = name;
149                         this.product = product;
150                 }
151         }
152
153         private static Product[] products = {
154                 new Product("telemetrum", product_telemetrum),
155                 new Product("teleballoon", product_telemetrum),
156                 new Product("teledongle", product_teledongle),
157                 new Product("easytimer", product_easytimer),
158                 new Product("telebt", product_telebt),
159                 new Product("telelaunch", product_telelaunch),
160                 new Product("telelco", product_telelco),
161                 new Product("telescience", product_telescience),
162                 new Product("telepyro", product_telepyro),
163                 new Product("telemega", product_telemega),
164                 new Product("megadongle", product_megadongle),
165                 new Product("telegps", product_telegps),
166                 new Product("easymini", product_easymini),
167                 new Product("telemini", product_telemini),
168                 new Product("easymega", product_easymega),
169                 new Product("easymotor", product_easymotor)
170         };
171
172         public static int name_to_product(String name) {
173                 String low = name.toLowerCase();
174
175                 for (int i = 0; i < products.length; i++)
176                         if (low.startsWith(products[i].name))
177                                 return products[i].product;
178                 return product_any;
179         }
180
181         public static boolean has_9dof(int device_type) {
182                 return device_type == product_telemega || device_type == product_easymega;
183         }
184
185         public static boolean has_radio(int device_type) {
186                 return device_type != product_easymini && device_type != product_easymega;
187         }
188
189         public static boolean has_gps(int device_type) {
190                 return device_type == product_telemetrum ||
191                         device_type == product_telemega ||
192                         device_type == product_telegps;
193         }
194
195         /* Bluetooth "identifier" (bluetooth sucks) */
196         public final static String bt_product_telebt = "TeleBT";
197
198         /* "good" voltages */
199
200         public final static double ao_battery_good = 3.8;
201         public final static double ao_igniter_good = 3.5;
202
203         /* Telemetry modes */
204         public static final int ao_telemetry_off = 0;
205         public static final int ao_telemetry_min = 1;
206         public static final int ao_telemetry_standard = 1;
207         public static final int ao_telemetry_0_9 = 2;
208         public static final int ao_telemetry_0_8 = 3;
209         public static final int ao_telemetry_max = 3;
210
211         private static final String[] ao_telemetry_name = {
212                 "Off", "Standard Telemetry", "TeleMetrum v0.9", "TeleMetrum v0.8"
213         };
214
215         public static final int ao_telemetry_rate_38400 = 0;
216         public static final int ao_telemetry_rate_9600 = 1;
217         public static final int ao_telemetry_rate_2400 = 2;
218         public static final int ao_telemetry_rate_max = 2;
219
220         public static final Integer[] ao_telemetry_rate_values = {
221                 38400, 9600, 2400
222         };
223
224         public static final int ao_aprs_format_compressed = 0;
225         public static final int ao_aprs_format_uncompressed = 1;
226
227         public static final String[] ao_aprs_format_name = {
228                 "Compressed", "Uncompressed"
229         };
230
231         public static final String launch_sites_url = "https://maps.altusmetrum.org/launch-sites.txt";
232         public static final String launch_sites_env = "LAUNCH_SITES";
233 //      public static final String launch_sites_url = "file:///home/keithp/misc/text/altusmetrum/AltOS/launch-sites.txt";
234
235         public static final String unit_info_url = "https://altusmetrum.org/cgi-bin/unitinfo.cgi?sn=%d";
236         public static final String unit_info_env = "UNIT_INFO";
237
238         public static final int ao_telemetry_standard_len = 32;
239         public static final int ao_telemetry_0_9_len = 95;
240         public static final int ao_telemetry_0_8_len = 94;
241
242         private static final int[] ao_telemetry_len = {
243                 0, 32, 95, 94
244         };
245
246         private static HashMap<String,Integer>  string_to_state = new HashMap<String,Integer>();
247
248         private static boolean map_initialized = false;
249
250         public static void initialize_map()
251         {
252                 string_to_state.put("startup", ao_flight_startup);
253                 string_to_state.put("idle", ao_flight_idle);
254                 string_to_state.put("pad", ao_flight_pad);
255                 string_to_state.put("boost", ao_flight_boost);
256                 string_to_state.put("fast", ao_flight_fast);
257                 string_to_state.put("coast", ao_flight_coast);
258                 string_to_state.put("drogue", ao_flight_drogue);
259                 string_to_state.put("apogee", ao_flight_coast);
260                 string_to_state.put("main", ao_flight_main);
261                 string_to_state.put("landed", ao_flight_landed);
262                 string_to_state.put("invalid", ao_flight_invalid);
263                 string_to_state.put("stateless", ao_flight_stateless);
264                 map_initialized = true;
265         }
266
267         public static int telemetry_len(int telemetry) {
268                 if (telemetry <= ao_telemetry_max)
269                         return ao_telemetry_len[telemetry];
270                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
271                                                                  telemetry));
272         }
273
274         public static String telemetry_name(int telemetry) {
275                 if (telemetry <= ao_telemetry_max)
276                         return ao_telemetry_name[telemetry];
277                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
278                                                                  telemetry));
279         }
280
281         private static int[] split_version(String version) {
282                 String[] tokens = version.split("\\.");
283                 int[] ret = new int[tokens.length];
284                 for (int i = 0; i < tokens.length; i++)
285                         ret[i] = Integer.parseInt(tokens[i]);
286                 return ret;
287         }
288
289         public static int compare_version(String version_a, String version_b) {
290                 int[] a = split_version(version_a);
291                 int[] b = split_version(version_b);
292
293                 for (int i = 0; i < Math.min(a.length, b.length); i++) {
294                         if (a[i] < b[i])
295                                 return -1;
296                         if (a[i] > b[i])
297                                 return 1;
298                 }
299                 if (a.length < b.length)
300                         return -1;
301                 if (a.length > b.length)
302                         return 1;
303                 return 0;
304         }
305
306         private static String[] state_to_string = {
307                 "startup",
308                 "idle",
309                 "pad",
310                 "boost",
311                 "fast",
312                 "coast",
313                 "drogue",
314                 "main",
315                 "landed",
316                 "invalid",
317                 "stateless",
318         };
319
320         private static String[] state_to_string_capital = {
321                 "Startup",
322                 "Idle",
323                 "Pad",
324                 "Boost",
325                 "Fast",
326                 "Coast",
327                 "Drogue",
328                 "Main",
329                 "Landed",
330                 "Invalid",
331                 "Stateless",
332         };
333
334         public static int state(String state) {
335                 if (!map_initialized)
336                         initialize_map();
337                 if (string_to_state.containsKey(state))
338                         return string_to_state.get(state);
339                 return ao_flight_invalid;
340         }
341
342         public static String state_name(int state) {
343                 if (state < 0 || state_to_string.length <= state)
344                         return "invalid";
345                 return state_to_string[state];
346         }
347
348         public static String state_name_capital(int state) {
349                 if (state < 0 || state_to_string.length <= state)
350                         return "Invalid";
351                 return state_to_string_capital[state];
352         }
353
354         public static final int AO_GPS_VALID = (1 << 4);
355         public static final int AO_GPS_RUNNING = (1 << 5);
356         public static final int AO_GPS_DATE_VALID = (1 << 6);
357         public static final int AO_GPS_NUM_SAT_SHIFT = 0;
358         public static final int AO_GPS_NUM_SAT_MASK = 0xf;
359
360         public static final int AO_PAD_ORIENTATION_ANTENNA_UP = 0;
361         public static final int AO_PAD_ORIENTATION_ANTENNA_DOWN = 1;
362         public static final int AO_PAD_ORIENTATION_WORDS_UPRIGHT = 2;
363         public static final int AO_PAD_ORIENTATION_WORDS_UPSIDEDOWN = 3;
364         public static final int AO_PAD_ORIENTATION_BIG_PARTS_UP = 4;
365         public static final int AO_PAD_ORIENTATION_BIG_PARTS_DOWN = 5;
366
367         public static final int AO_LOG_FORMAT_UNKNOWN = 0;
368         public static final int AO_LOG_FORMAT_FULL = 1;
369         public static final int AO_LOG_FORMAT_TINY = 2;
370         public static final int AO_LOG_FORMAT_TELEMETRY = 3;
371         public static final int AO_LOG_FORMAT_TELESCIENCE = 4;
372         public static final int AO_LOG_FORMAT_TELEMEGA_OLD = 5;
373         public static final int AO_LOG_FORMAT_EASYMINI1 = 6;
374         public static final int AO_LOG_FORMAT_TELEMETRUM = 7;
375         public static final int AO_LOG_FORMAT_TELEMINI2 = 8;
376         public static final int AO_LOG_FORMAT_TELEGPS = 9;
377         public static final int AO_LOG_FORMAT_TELEMEGA = 10;
378         public static final int AO_LOG_FORMAT_DETHERM = 11;
379         public static final int AO_LOG_FORMAT_TELEMINI3 = 12;
380         public static final int AO_LOG_FORMAT_TELEFIRETWO = 13;
381         public static final int AO_LOG_FORMAT_EASYMINI2 = 14;
382         public static final int AO_LOG_FORMAT_TELEMEGA_3 = 15;
383         public static final int AO_LOG_FORMAT_EASYMEGA_2 = 16;
384         public static final int AO_LOG_FORMAT_TELESTATIC = 17;
385         public static final int AO_LOG_FORMAT_MICROPEAK2 = 18;
386         public static final int AO_LOG_FORMAT_TELEMEGA_4 = 19;
387         public static final int AO_LOG_FORMAT_EASYMOTOR = 20;
388         public static final int AO_LOG_FORMAT_NONE = 127;
389
390         public static boolean isspace(int c) {
391                 switch (c) {
392                 case ' ':
393                 case '\t':
394                         return true;
395                 }
396                 return false;
397         }
398
399         public static final boolean ishex(int c) {
400                 if ('0' <= c && c <= '9')
401                         return true;
402                 if ('a' <= c && c <= 'f')
403                         return true;
404                 if ('A' <= c && c <= 'F')
405                         return true;
406                 return false;
407         }
408
409         public static final boolean ishex(String s) {
410                 for (int i = 0; i < s.length(); i++)
411                         if (!ishex(s.charAt(i)))
412                                 return false;
413                 return true;
414         }
415
416         public static int fromhex(int c) {
417                 if ('0' <= c && c <= '9')
418                         return c - '0';
419                 if ('a' <= c && c <= 'f')
420                         return c - 'a' + 10;
421                 if ('A' <= c && c <= 'F')
422                         return c - 'A' + 10;
423                 return -1;
424         }
425
426         public static int fromhex(String s) throws NumberFormatException {
427                 int c, v = 0;
428                 for (int i = 0; i < s.length(); i++) {
429                         c = s.charAt(i);
430                         if (!ishex(c)) {
431                                 if (i == 0)
432                                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
433                                 return v;
434                         }
435                         v = v * 16 + fromhex(c);
436                 }
437                 return v;
438         }
439
440         public static boolean isdec(int c) {
441                 if ('0' <= c && c <= '9')
442                         return true;
443                 return false;
444         }
445
446         public static boolean isdec(String s) {
447                 for (int i = 0; i < s.length(); i++)
448                         if (!isdec(s.charAt(i)))
449                                 return false;
450                 return true;
451         }
452
453         public static int fromdec(int c) {
454                 if ('0' <= c && c <= '9')
455                         return c - '0';
456                 return -1;
457         }
458
459         public static int int8(int[] bytes, int i) {
460                 return (int) (byte) bytes[i];
461         }
462
463         public static int uint8(int[] bytes, int i) {
464                 return bytes[i];
465         }
466
467         public static int int16(int[] bytes, int i) {
468                 return (int) (short) (bytes[i] + (bytes[i+1] << 8));
469         }
470
471         public static int uint16(int[] bytes, int i) {
472                 return bytes[i] + (bytes[i+1] << 8);
473         }
474
475         public static int uint32(int[] bytes, int i) {
476                 return bytes[i] +
477                         (bytes[i+1] << 8) +
478                         (bytes[i+2] << 16) +
479                         (bytes[i+3] << 24);
480         }
481
482         public static int int32(int[] bytes, int i) {
483                 return (int) uint32(bytes, i);
484         }
485
486         public static final Charset     unicode_set = Charset.forName("UTF-8");
487
488         public static String string(int[] bytes, int s, int l) {
489                 if (s + l > bytes.length) {
490                         if (s > bytes.length) {
491                                 s = bytes.length;
492                                 l = 0;
493                         } else {
494                                 l = bytes.length - s;
495                         }
496                 }
497
498                 int i;
499                 for (i = l - 1; i >= 0; i--)
500                         if (bytes[s+i] != 0)
501                                 break;
502
503                 l = i + 1;
504                 byte[]  b = new byte[l];
505
506                 for (i = 0; i < l; i++)
507                         b[i] = (byte) bytes[s+i];
508                 String n = new String(b, unicode_set);
509                 return n;
510         }
511
512         public static int hexbyte(String s, int i) {
513                 int c0, c1;
514
515                 if (s.length() < i + 2)
516                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
517                 c0 = s.charAt(i);
518                 if (!ishex(c0))
519                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c0));
520                 c1 = s.charAt(i+1);
521                 if (!ishex(c1))
522                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c1));
523                 return fromhex(c0) * 16 + fromhex(c1);
524         }
525
526         public static int[] hexbytes(String s) {
527                 int     n;
528                 int[]   r;
529                 int     i;
530
531                 if ((s.length() & 1) != 0)
532                         throw new NumberFormatException(String.format("invalid line \"%s\"", s));
533                 byte[] bytes = s.getBytes(unicode_set);
534                 n = bytes.length / 2;
535                 r = new int[n];
536                 for (i = 0; i < n; i++) {
537                         int h = fromhex(bytes[(i << 1)]);
538                         int l = fromhex(bytes[(i << 1) + 1]);
539                         if (h < 0 || l < 0)
540                                 throw new NumberFormatException(String.format("invalid hex \"%c%c\"",
541                                                                               bytes[(i<<1)], bytes[(i<<1) + 1]));
542                         r[i] = (h << 4) + l;
543                 }
544                 return r;
545         }
546
547         public static long fromdec(String s) throws NumberFormatException {
548                 int c;
549                 long v = 0;
550                 long sign = 1;
551                 for (int i = 0; i < s.length(); i++) {
552                         c = s.charAt(i);
553                         if (i == 0 && c == '-') {
554                                 sign = -1;
555                         } else if (!isdec(c)) {
556                                 if (i == 0)
557                                         throw new NumberFormatException(String.format("invalid number \"%s\"", s));
558                                 return v;
559                         } else
560                                 v = v * 10 + fromdec(c);
561                 }
562                 return v * sign;
563         }
564
565         public static String gets(FileInputStream s) throws IOException {
566                 int c;
567                 String  line = "";
568
569                 while ((c = s.read()) != -1) {
570                         if (c == '\r')
571                                 continue;
572                         if (c == '\n') {
573                                 return line;
574                         }
575                         line = line + (char) c;
576                 }
577                 return null;
578         }
579
580         public static String replace_extension(String input, String extension) {
581                 int dot = input.lastIndexOf(".");
582                 if (dot > 0)
583                         input = input.substring(0,dot);
584                 return input.concat(extension);
585         }
586
587         public static File replace_extension(File input, String extension) {
588                 return new File(replace_extension(input.getPath(), extension));
589         }
590
591         public static String product_name(int product_id) {
592                 switch (product_id) {
593                 case product_altusmetrum: return "AltusMetrum";
594                 case product_telemetrum: return "TeleMetrum";
595                 case product_teledongle: return "TeleDongle";
596                 case product_easytimer: return "EasyTimer";
597                 case product_telebt: return "TeleBT";
598                 case product_telelaunch: return "TeleLaunch";
599                 case product_telelco: return "TeleLco";
600                 case product_telescience: return "Telescience";
601                 case product_telepyro: return "TelePyro";
602                 case product_telemega: return "TeleMega";
603                 case product_megadongle: return "MegaDongle";
604                 case product_telegps: return "TeleGPS";
605                 case product_easymini: return "EasyMini";
606                 case product_telemini: return "TeleMini";
607                 case product_easymotor: return "EasyMotor";
608                 default: return "unknown";
609                 }
610         }
611
612         public static String igniter_name(int i) {
613                 return String.format("Igniter %c", 'A' + i);
614         }
615
616         public static String igniter_short_name(int i) {
617                 return String.format("igniter_%c", 'a' + i);
618         }
619
620         public static AltosRecordSet record_set(File file) throws FileNotFoundException, IOException {
621                 FileInputStream in;
622                 in = new FileInputStream(file);
623                 if (file.getName().endsWith("telem")) {
624                         return new AltosTelemetryFile(in);
625                 } else if (file.getName().endsWith("eeprom")) {
626                         return new AltosEepromFile(in);
627                 } else {
628                         String  name = file.getName();
629                         int     dot = name.lastIndexOf('.');
630                         String  extension;
631
632                         if (dot == -1)
633                                 throw new IOException(String.format("%s (Missing extension)", file.toString()));
634                         else {
635                                 extension = name.substring(dot);
636                                 throw new IOException(String.format("%s (Invalid extension '%s')",
637                                                                     file.toString(),
638                                                                     extension));
639                         }
640                 }
641         }
642
643 }