git.gag.com Git - fw/altos/blob - 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_11;
  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_teleterra = 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_altusmetrum_min = 0x000a;
 136         public final static int product_altusmetrum_max = 0x002c;
 137
 138         public final static int product_any = 0x10000;
 139         public final static int product_basestation = 0x10000 + 1;
 140         public final static int product_altimeter = 0x10000 + 2;
 141
 142         private static class Product {
 143                 final String    name;
 144                 final int       product;
 145
 146                 Product (String name, int product) {
 147                         this.name = name;
 148                         this.product = product;
 149                 }
 150         }
 151
 152         private static Product[] products = {
 153                 new Product("telemetrum", product_telemetrum),
 154                 new Product("teleballoon", product_telemetrum),
 155                 new Product("teledongle", product_teledongle),
 156                 new Product("teleterra", product_teledongle),
 157                 new Product("telebt", product_telebt),
 158                 new Product("telelaunch", product_telelaunch),
 159                 new Product("telelco", product_telelco),
 160                 new Product("telescience", product_telescience),
 161                 new Product("telepyro", product_telepyro),
 162                 new Product("telemega", product_telemega),
 163                 new Product("megadongle", product_megadongle),
 164                 new Product("telegps", product_telegps),
 165                 new Product("easymini", product_easymini),
 166                 new Product("telemini", product_telemini),
 167                 new Product("easymega", product_easymega)
 168         };
 169
 170         public static int name_to_product(String name) {
 171                 String low = name.toLowerCase();
 172
 173                 for (int i = 0; i < products.length; i++)
 174                         if (low.startsWith(products[i].name))
 175                                 return products[i].product;
 176                 return product_any;
 177         }
 178
 179         public static boolean has_9dof(int device_type) {
 180                 return device_type == product_telemega || device_type == product_easymega;
 181         }
 182
 183         public static boolean has_gps(int device_type) {
 184                 return device_type == product_telemetrum ||
 185                         device_type == product_telemega ||
 186                         device_type == product_telegps;
 187         }
 188
 189         /* Bluetooth "identifier" (bluetooth sucks) */
 190         public final static String bt_product_telebt = "TeleBT";
 191
 192         /* "good" voltages */
 193
 194         public final static double ao_battery_good = 3.8;
 195         public final static double ao_igniter_good = 3.5;
 196
 197         /* Telemetry modes */
 198         public static final int ao_telemetry_off = 0;
 199         public static final int ao_telemetry_min = 1;
 200         public static final int ao_telemetry_standard = 1;
 201         public static final int ao_telemetry_0_9 = 2;
 202         public static final int ao_telemetry_0_8 = 3;
 203         public static final int ao_telemetry_max = 3;
 204
 205         private static final String[] ao_telemetry_name = {
 206                 "Off", "Standard Telemetry", "TeleMetrum v0.9", "TeleMetrum v0.8"
 207         };
 208
 209         public static final int ao_telemetry_rate_38400 = 0;
 210         public static final int ao_telemetry_rate_9600 = 1;
 211         public static final int ao_telemetry_rate_2400 = 2;
 212         public static final int ao_telemetry_rate_max = 2;
 213
 214         public static final Integer[] ao_telemetry_rate_values = {
 215                 38400, 9600, 2400
 216         };
 217
 218         public static final int ao_aprs_format_compressed = 0;
 219         public static final int ao_aprs_format_uncompressed = 1;
 220
 221         public static final String[] ao_aprs_format_name = {
 222                 "Compressed", "Uncompressed"
 223         };
 224
 225         public static final String launch_sites_url = "http://www.altusmetrum.org/AltOS/launch-sites.txt";
 226         public static final String launch_sites_env = "LAUNCH_SITES";
 227 //      public static final String launch_sites_url = "file:///home/keithp/misc/text/altusmetrum/AltOS/launch-sites.txt";
 228
 229         public static final int ao_telemetry_standard_len = 32;
 230         public static final int ao_telemetry_0_9_len = 95;
 231         public static final int ao_telemetry_0_8_len = 94;
 232
 233         private static final int[] ao_telemetry_len = {
 234                 0, 32, 95, 94
 235         };
 236
 237         private static HashMap<String,Integer>  string_to_state = new HashMap<String,Integer>();
 238
 239         private static boolean map_initialized = false;
 240
 241         public static void initialize_map()
 242         {
 243                 string_to_state.put("startup", ao_flight_startup);
 244                 string_to_state.put("idle", ao_flight_idle);
 245                 string_to_state.put("pad", ao_flight_pad);
 246                 string_to_state.put("boost", ao_flight_boost);
 247                 string_to_state.put("fast", ao_flight_fast);
 248                 string_to_state.put("coast", ao_flight_coast);
 249                 string_to_state.put("drogue", ao_flight_drogue);
 250                 string_to_state.put("apogee", ao_flight_coast);
 251                 string_to_state.put("main", ao_flight_main);
 252                 string_to_state.put("landed", ao_flight_landed);
 253                 string_to_state.put("invalid", ao_flight_invalid);
 254                 string_to_state.put("stateless", ao_flight_stateless);
 255                 map_initialized = true;
 256         }
 257
 258         public static int telemetry_len(int telemetry) {
 259                 if (telemetry <= ao_telemetry_max)
 260                         return ao_telemetry_len[telemetry];
 261                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 262                                                                  telemetry));
 263         }
 264
 265         public static String telemetry_name(int telemetry) {
 266                 if (telemetry <= ao_telemetry_max)
 267                         return ao_telemetry_name[telemetry];
 268                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 269                                                                  telemetry));
 270         }
 271
 272         private static int[] split_version(String version) {
 273                 String[] tokens = version.split("\\.");
 274                 int[] ret = new int[tokens.length];
 275                 for (int i = 0; i < tokens.length; i++)
 276                         ret[i] = Integer.parseInt(tokens[i]);
 277                 return ret;
 278         }
 279
 280         public static int compare_version(String version_a, String version_b) {
 281                 int[] a = split_version(version_a);
 282                 int[] b = split_version(version_b);
 283
 284                 for (int i = 0; i < Math.min(a.length, b.length); i++) {
 285                         if (a[i] < b[i])
 286                                 return -1;
 287                         if (a[i] > b[i])
 288                                 return 1;
 289                 }
 290                 if (a.length < b.length)
 291                         return -1;
 292                 if (a.length > b.length)
 293                         return 1;
 294                 return 0;
 295         }
 296
 297         private static String[] state_to_string = {
 298                 "startup",
 299                 "idle",
 300                 "pad",
 301                 "boost",
 302                 "fast",
 303                 "coast",
 304                 "drogue",
 305                 "main",
 306                 "landed",
 307                 "invalid",
 308                 "stateless",
 309         };
 310
 311         private static String[] state_to_string_capital = {
 312                 "Startup",
 313                 "Idle",
 314                 "Pad",
 315                 "Boost",
 316                 "Fast",
 317                 "Coast",
 318                 "Drogue",
 319                 "Main",
 320                 "Landed",
 321                 "Invalid",
 322                 "Stateless",
 323         };
 324
 325         public static int state(String state) {
 326                 if (!map_initialized)
 327                         initialize_map();
 328                 if (string_to_state.containsKey(state))
 329                         return string_to_state.get(state);
 330                 return ao_flight_invalid;
 331         }
 332
 333         public static String state_name(int state) {
 334                 if (state < 0 || state_to_string.length <= state)
 335                         return "invalid";
 336                 return state_to_string[state];
 337         }
 338
 339         public static String state_name_capital(int state) {
 340                 if (state < 0 || state_to_string.length <= state)
 341                         return "Invalid";
 342                 return state_to_string_capital[state];
 343         }
 344
 345         public static final int AO_GPS_VALID = (1 << 4);
 346         public static final int AO_GPS_RUNNING = (1 << 5);
 347         public static final int AO_GPS_DATE_VALID = (1 << 6);
 348         public static final int AO_GPS_NUM_SAT_SHIFT = 0;
 349         public static final int AO_GPS_NUM_SAT_MASK = 0xf;
 350
 351         public static final int AO_LOG_FORMAT_UNKNOWN = 0;
 352         public static final int AO_LOG_FORMAT_FULL = 1;
 353         public static final int AO_LOG_FORMAT_TINY = 2;
 354         public static final int AO_LOG_FORMAT_TELEMETRY = 3;
 355         public static final int AO_LOG_FORMAT_TELESCIENCE = 4;
 356         public static final int AO_LOG_FORMAT_TELEMEGA_OLD = 5;
 357         public static final int AO_LOG_FORMAT_EASYMINI1 = 6;
 358         public static final int AO_LOG_FORMAT_TELEMETRUM = 7;
 359         public static final int AO_LOG_FORMAT_TELEMINI2 = 8;
 360         public static final int AO_LOG_FORMAT_TELEGPS = 9;
 361         public static final int AO_LOG_FORMAT_TELEMEGA = 10;
 362         public static final int AO_LOG_FORMAT_DETHERM = 11;
 363         public static final int AO_LOG_FORMAT_TELEMINI3 = 12;
 364         public static final int AO_LOG_FORMAT_TELEFIRETWO = 13;
 365         public static final int AO_LOG_FORMAT_EASYMINI2 = 14;
 366         public static final int AO_LOG_FORMAT_NONE = 127;
 367
 368         public static boolean isspace(int c) {
 369                 switch (c) {
 370                 case ' ':
 371                 case '\t':
 372                         return true;
 373                 }
 374                 return false;
 375         }
 376
 377         public static final boolean ishex(int c) {
 378                 if ('0' <= c && c <= '9')
 379                         return true;
 380                 if ('a' <= c && c <= 'f')
 381                         return true;
 382                 if ('A' <= c && c <= 'F')
 383                         return true;
 384                 return false;
 385         }
 386
 387         public static final boolean ishex(String s) {
 388                 for (int i = 0; i < s.length(); i++)
 389                         if (!ishex(s.charAt(i)))
 390                                 return false;
 391                 return true;
 392         }
 393
 394         public static int fromhex(int c) {
 395                 if ('0' <= c && c <= '9')
 396                         return c - '0';
 397                 if ('a' <= c && c <= 'f')
 398                         return c - 'a' + 10;
 399                 if ('A' <= c && c <= 'F')
 400                         return c - 'A' + 10;
 401                 return -1;
 402         }
 403
 404         public static int fromhex(String s) throws NumberFormatException {
 405                 int c, v = 0;
 406                 for (int i = 0; i < s.length(); i++) {
 407                         c = s.charAt(i);
 408                         if (!ishex(c)) {
 409                                 if (i == 0)
 410                                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 411                                 return v;
 412                         }
 413                         v = v * 16 + fromhex(c);
 414                 }
 415                 return v;
 416         }
 417
 418         public static boolean isdec(int c) {
 419                 if ('0' <= c && c <= '9')
 420                         return true;
 421                 return false;
 422         }
 423
 424         public static boolean isdec(String s) {
 425                 for (int i = 0; i < s.length(); i++)
 426                         if (!isdec(s.charAt(i)))
 427                                 return false;
 428                 return true;
 429         }
 430
 431         public static int fromdec(int c) {
 432                 if ('0' <= c && c <= '9')
 433                         return c - '0';
 434                 return -1;
 435         }
 436
 437         public static int int8(int[] bytes, int i) {
 438                 return (int) (byte) bytes[i];
 439         }
 440
 441         public static int uint8(int[] bytes, int i) {
 442                 return bytes[i];
 443         }
 444
 445         public static int int16(int[] bytes, int i) {
 446                 return (int) (short) (bytes[i] + (bytes[i+1] << 8));
 447         }
 448
 449         public static int uint16(int[] bytes, int i) {
 450                 return bytes[i] + (bytes[i+1] << 8);
 451         }
 452
 453         public static int uint32(int[] bytes, int i) {
 454                 return bytes[i] +
 455                         (bytes[i+1] << 8) +
 456                         (bytes[i+2] << 16) +
 457                         (bytes[i+3] << 24);
 458         }
 459
 460         public static int int32(int[] bytes, int i) {
 461                 return (int) uint32(bytes, i);
 462         }
 463
 464         public static final Charset     unicode_set = Charset.forName("UTF-8");
 465
 466         public static String string(int[] bytes, int s, int l) {
 467                 if (s + l > bytes.length) {
 468                         if (s > bytes.length) {
 469                                 s = bytes.length;
 470                                 l = 0;
 471                         } else {
 472                                 l = bytes.length - s;
 473                         }
 474                 }
 475
 476                 int i;
 477                 for (i = l - 1; i >= 0; i--)
 478                         if (bytes[s+i] != 0)
 479                                 break;
 480
 481                 l = i + 1;
 482                 byte[]  b = new byte[l];
 483
 484                 for (i = 0; i < l; i++)
 485                         b[i] = (byte) bytes[s+i];
 486                 String n = new String(b, unicode_set);
 487                 return n;
 488         }
 489
 490         public static int hexbyte(String s, int i) {
 491                 int c0, c1;
 492
 493                 if (s.length() < i + 2)
 494                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 495                 c0 = s.charAt(i);
 496                 if (!ishex(c0))
 497                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c0));
 498                 c1 = s.charAt(i+1);
 499                 if (!ishex(c1))
 500                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c1));
 501                 return fromhex(c0) * 16 + fromhex(c1);
 502         }
 503
 504         public static int[] hexbytes(String s) {
 505                 int     n;
 506                 int[]   r;
 507                 int     i;
 508
 509                 if ((s.length() & 1) != 0)
 510                         throw new NumberFormatException(String.format("invalid line \"%s\"", s));
 511                 byte[] bytes = s.getBytes(unicode_set);
 512                 n = bytes.length / 2;
 513                 r = new int[n];
 514                 for (i = 0; i < n; i++) {
 515                         int h = fromhex(bytes[(i << 1)]);
 516                         int l = fromhex(bytes[(i << 1) + 1]);
 517                         if (h < 0 || l < 0)
 518                                 throw new NumberFormatException(String.format("invalid hex \"%c%c\"",
 519                                                                               bytes[(i<<1)], bytes[(i<<1) + 1]));
 520                         r[i] = (h << 4) + l;
 521                 }
 522                 return r;
 523         }
 524
 525         public static long fromdec(String s) throws NumberFormatException {
 526                 int c;
 527                 long v = 0;
 528                 long sign = 1;
 529                 for (int i = 0; i < s.length(); i++) {
 530                         c = s.charAt(i);
 531                         if (i == 0 && c == '-') {
 532                                 sign = -1;
 533                         } else if (!isdec(c)) {
 534                                 if (i == 0)
 535                                         throw new NumberFormatException(String.format("invalid number \"%s\"", s));
 536                                 return v;
 537                         } else
 538                                 v = v * 10 + fromdec(c);
 539                 }
 540                 return v * sign;
 541         }
 542
 543         public static String gets(FileInputStream s) throws IOException {
 544                 int c;
 545                 String  line = "";
 546
 547                 while ((c = s.read()) != -1) {
 548                         if (c == '\r')
 549                                 continue;
 550                         if (c == '\n') {
 551                                 return line;
 552                         }
 553                         line = line + (char) c;
 554                 }
 555                 return null;
 556         }
 557
 558         public static String replace_extension(String input, String extension) {
 559                 int dot = input.lastIndexOf(".");
 560                 if (dot > 0)
 561                         input = input.substring(0,dot);
 562                 return input.concat(extension);
 563         }
 564
 565         public static File replace_extension(File input, String extension) {
 566                 return new File(replace_extension(input.getPath(), extension));
 567         }
 568
 569         public static String product_name(int product_id) {
 570                 switch (product_id) {
 571                 case product_altusmetrum: return "AltusMetrum";
 572                 case product_telemetrum: return "TeleMetrum";
 573                 case product_teledongle: return "TeleDongle";
 574                 case product_teleterra: return "TeleTerra";
 575                 case product_telebt: return "TeleBT";
 576                 case product_telelaunch: return "TeleLaunch";
 577                 case product_telelco: return "TeleLco";
 578                 case product_telescience: return "Telescience";
 579                 case product_telepyro: return "TelePyro";
 580                 case product_telemega: return "TeleMega";
 581                 case product_megadongle: return "MegaDongle";
 582                 case product_telegps: return "TeleGPS";
 583                 case product_easymini: return "EasyMini";
 584                 case product_telemini: return "TeleMini";
 585                 default: return "unknown";
 586                 }
 587         }
 588
 589         public static String igniter_name(int i) {
 590                 return String.format("Ignitor %c", 'A' + i);
 591         }
 592
 593         public static AltosRecordSet record_set(File file) throws FileNotFoundException, IOException {
 594                 FileInputStream in;
 595                 in = new FileInputStream(file);
 596                 if (file.getName().endsWith("telem")) {
 597                         return new AltosTelemetryFile(in);
 598                 } else if (file.getName().endsWith("eeprom")) {
 599                         return new AltosEepromFile(in);
 600                 } else {
 601                         String  name = file.getName();
 602                         int     dot = name.lastIndexOf('.');
 603                         String  extension;
 604
 605                         if (dot == -1)
 606                                 throw new IOException(String.format("%s (Missing extension)", file.toString()));
 607                         else {
 608                                 extension = name.substring(dot);
 609                                 throw new IOException(String.format("%s (Invalid extension '%s')",
 610                                                                     file.toString(),
 611                                                                     extension));
 612                         }
 613                 }
 614         }
 615
 616 }