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