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_2;
  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         /* Added for header fields in telemega files */
  55         public static final int AO_LOG_BARO_RESERVED = 3000;
  56         public static final int AO_LOG_BARO_SENS = 3001;
  57         public static final int AO_LOG_BARO_OFF = 3002;
  58         public static final int AO_LOG_BARO_TCS = 3004;
  59         public static final int AO_LOG_BARO_TCO = 3005;
  60         public static final int AO_LOG_BARO_TREF = 3006;
  61         public static final int AO_LOG_BARO_TEMPSENS = 3007;
  62         public static final int AO_LOG_BARO_CRC = 3008;
  63
  64         public static final int AO_LOG_SOFTWARE_VERSION = 9999;
  65
  66         public final static int MISSING = 0x7fffffff;
  67
  68         /* Added to flag invalid records */
  69         public static final int AO_LOG_INVALID = -1;
  70
  71         /* Flight state numbers and names */
  72         public static final int ao_flight_startup = 0;
  73         public static final int ao_flight_idle = 1;
  74         public static final int ao_flight_pad = 2;
  75         public static final int ao_flight_boost = 3;
  76         public static final int ao_flight_fast = 4;
  77         public static final int ao_flight_coast = 5;
  78         public static final int ao_flight_drogue = 6;
  79         public static final int ao_flight_main = 7;
  80         public static final int ao_flight_landed = 8;
  81         public static final int ao_flight_invalid = 9;
  82
  83         /* USB product IDs */
  84         public final static int vendor_altusmetrum = 0xfffe;
  85
  86         public final static int product_altusmetrum = 0x000a;
  87         public final static int product_telemetrum = 0x000b;
  88         public final static int product_teledongle = 0x000c;
  89         public final static int product_teleterra = 0x000d;
  90         public final static int product_telebt = 0x000e;
  91         public final static int product_telelaunch = 0x000f;
  92         public final static int product_telelco = 0x0010;
  93         public final static int product_telescience = 0x0011;
  94         public final static int product_telepyro =0x0012;
  95         public final static int product_telemega = 0x0023;
  96         public final static int product_megadongle = 0x0024;
  97         public final static int product_telegps = 0x0025;
  98         public final static int product_easymini = 0x0026;
  99         public final static int product_telemini = 0x0027;
 100         public final static int product_altusmetrum_min = 0x000a;
 101         public final static int product_altusmetrum_max = 0x002c;
 102
 103         public final static int product_any = 0x10000;
 104         public final static int product_basestation = 0x10000 + 1;
 105         public final static int product_altimeter = 0x10000 + 2;
 106
 107         private static class Product {
 108                 final String    name;
 109                 final int       product;
 110
 111                 Product (String name, int product) {
 112                         this.name = name;
 113                         this.product = product;
 114                 }
 115         }
 116
 117         private static Product[] products = {
 118                 new Product("telemetrum", product_telemetrum),
 119                 new Product("teleballoon", product_telemetrum),
 120                 new Product("teledongle", product_teledongle),
 121                 new Product("teleterra", product_teledongle),
 122                 new Product("telebt", product_telebt),
 123                 new Product("telelaunch", product_telelaunch),
 124                 new Product("telelco", product_telelco),
 125                 new Product("telescience", product_telescience),
 126                 new Product("telepyro", product_telepyro),
 127                 new Product("telemega", product_telemega),
 128                 new Product("megadongle", product_megadongle),
 129                 new Product("telegps", product_telegps),
 130                 new Product("easymini", product_easymini),
 131                 new Product("telemini", product_telemini)
 132         };
 133
 134         public static int name_to_product(String name) {
 135                 String low = name.toLowerCase();
 136
 137                 for (int i = 0; i < products.length; i++)
 138                         if (low.startsWith(products[i].name))
 139                                 return products[i].product;
 140                 return product_any;
 141         }
 142
 143         /* Bluetooth "identifier" (bluetooth sucks) */
 144         public final static String bt_product_telebt = "TeleBT";
 145
 146         /* Telemetry modes */
 147         public static final int ao_telemetry_off = 0;
 148         public static final int ao_telemetry_min = 1;
 149         public static final int ao_telemetry_standard = 1;
 150         public static final int ao_telemetry_0_9 = 2;
 151         public static final int ao_telemetry_0_8 = 3;
 152         public static final int ao_telemetry_max = 3;
 153
 154         private static final String[] ao_telemetry_name = {
 155                 "Off", "Standard Telemetry", "TeleMetrum v0.9", "TeleMetrum v0.8"
 156         };
 157
 158         public static final String launch_sites_url = "http://www.altusmetrum.org/AltOS/launch-sites.txt";
 159
 160         public static final int ao_telemetry_standard_len = 32;
 161         public static final int ao_telemetry_0_9_len = 95;
 162         public static final int ao_telemetry_0_8_len = 94;
 163
 164         private static final int[] ao_telemetry_len = {
 165                 0, 32, 95, 94
 166         };
 167
 168         private static HashMap<String,Integer>  string_to_state = new HashMap<String,Integer>();
 169
 170         private static boolean map_initialized = false;
 171
 172         public static void initialize_map()
 173         {
 174                 string_to_state.put("startup", ao_flight_startup);
 175                 string_to_state.put("idle", ao_flight_idle);
 176                 string_to_state.put("pad", ao_flight_pad);
 177                 string_to_state.put("boost", ao_flight_boost);
 178                 string_to_state.put("fast", ao_flight_fast);
 179                 string_to_state.put("coast", ao_flight_coast);
 180                 string_to_state.put("drogue", ao_flight_drogue);
 181                 string_to_state.put("apogee", ao_flight_coast);
 182                 string_to_state.put("main", ao_flight_main);
 183                 string_to_state.put("landed", ao_flight_landed);
 184                 string_to_state.put("invalid", ao_flight_invalid);
 185                 map_initialized = true;
 186         }
 187
 188         public static int telemetry_len(int telemetry) {
 189                 if (telemetry <= ao_telemetry_max)
 190                         return ao_telemetry_len[telemetry];
 191                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 192                                                                  telemetry));
 193         }
 194
 195         public static String telemetry_name(int telemetry) {
 196                 if (telemetry <= ao_telemetry_max)
 197                         return ao_telemetry_name[telemetry];
 198                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 199                                                                  telemetry));
 200         }
 201
 202         private static String[] state_to_string = {
 203                 "startup",
 204                 "idle",
 205                 "pad",
 206                 "boost",
 207                 "fast",
 208                 "coast",
 209                 "drogue",
 210                 "main",
 211                 "landed",
 212                 "invalid",
 213         };
 214
 215         private static String[] state_to_string_capital = {
 216                 "Startup",
 217                 "Idle",
 218                 "Pad",
 219                 "Boost",
 220                 "Fast",
 221                 "Coast",
 222                 "Drogue",
 223                 "Main",
 224                 "Landed",
 225                 "Invalid",
 226         };
 227
 228         public static int state(String state) {
 229                 if (!map_initialized)
 230                         initialize_map();
 231                 if (string_to_state.containsKey(state))
 232                         return string_to_state.get(state);
 233                 return ao_flight_invalid;
 234         }
 235
 236         public static String state_name(int state) {
 237                 if (state < 0 || state_to_string.length <= state)
 238                         return "invalid";
 239                 return state_to_string[state];
 240         }
 241
 242         public static String state_name_capital(int state) {
 243                 if (state < 0 || state_to_string.length <= state)
 244                         return "Invalid";
 245                 return state_to_string_capital[state];
 246         }
 247
 248         public static final int AO_GPS_VALID = (1 << 4);
 249         public static final int AO_GPS_RUNNING = (1 << 5);
 250         public static final int AO_GPS_DATE_VALID = (1 << 6);
 251         public static final int AO_GPS_NUM_SAT_SHIFT = 0;
 252         public static final int AO_GPS_NUM_SAT_MASK = 0xf;
 253
 254         public static final int AO_LOG_FORMAT_UNKNOWN = 0;
 255         public static final int AO_LOG_FORMAT_FULL = 1;
 256         public static final int AO_LOG_FORMAT_TINY = 2;
 257         public static final int AO_LOG_FORMAT_TELEMETRY = 3;
 258         public static final int AO_LOG_FORMAT_TELESCIENCE = 4;
 259         public static final int AO_LOG_FORMAT_TELEMEGA = 5;
 260         public static final int AO_LOG_FORMAT_EASYMINI = 6;
 261         public static final int AO_LOG_FORMAT_TELEMETRUM = 7;
 262         public static final int AO_LOG_FORMAT_TELEMINI = 8;
 263         public static final int AO_LOG_FORMAT_NONE = 127;
 264
 265         public static boolean isspace(int c) {
 266                 switch (c) {
 267                 case ' ':
 268                 case '\t':
 269                         return true;
 270                 }
 271                 return false;
 272         }
 273
 274         public static boolean ishex(int c) {
 275                 if ('0' <= c && c <= '9')
 276                         return true;
 277                 if ('a' <= c && c <= 'f')
 278                         return true;
 279                 if ('A' <= c && c <= 'F')
 280                         return true;
 281                 return false;
 282         }
 283
 284         public static boolean ishex(String s) {
 285                 for (int i = 0; i < s.length(); i++)
 286                         if (!ishex(s.charAt(i)))
 287                                 return false;
 288                 return true;
 289         }
 290
 291         public static int fromhex(int c) {
 292                 if ('0' <= c && c <= '9')
 293                         return c - '0';
 294                 if ('a' <= c && c <= 'f')
 295                         return c - 'a' + 10;
 296                 if ('A' <= c && c <= 'F')
 297                         return c - 'A' + 10;
 298                 return -1;
 299         }
 300
 301         public static int fromhex(String s) throws NumberFormatException {
 302                 int c, v = 0;
 303                 for (int i = 0; i < s.length(); i++) {
 304                         c = s.charAt(i);
 305                         if (!ishex(c)) {
 306                                 if (i == 0)
 307                                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 308                                 return v;
 309                         }
 310                         v = v * 16 + fromhex(c);
 311                 }
 312                 return v;
 313         }
 314
 315         public static boolean isdec(int c) {
 316                 if ('0' <= c && c <= '9')
 317                         return true;
 318                 return false;
 319         }
 320
 321         public static boolean isdec(String s) {
 322                 for (int i = 0; i < s.length(); i++)
 323                         if (!isdec(s.charAt(i)))
 324                                 return false;
 325                 return true;
 326         }
 327
 328         public static int fromdec(int c) {
 329                 if ('0' <= c && c <= '9')
 330                         return c - '0';
 331                 return -1;
 332         }
 333
 334         public static int int8(int[] bytes, int i) {
 335                 return (int) (byte) bytes[i];
 336         }
 337
 338         public static int uint8(int[] bytes, int i) {
 339                 return bytes[i];
 340         }
 341
 342         public static int int16(int[] bytes, int i) {
 343                 return (int) (short) (bytes[i] + (bytes[i+1] << 8));
 344         }
 345
 346         public static int uint16(int[] bytes, int i) {
 347                 return bytes[i] + (bytes[i+1] << 8);
 348         }
 349
 350         public static int uint32(int[] bytes, int i) {
 351                 return bytes[i] +
 352                         (bytes[i+1] << 8) +
 353                         (bytes[i+2] << 16) +
 354                         (bytes[i+3] << 24);
 355         }
 356
 357         public static int int32(int[] bytes, int i) {
 358                 return (int) uint32(bytes, i);
 359         }
 360
 361         public static final Charset     unicode_set = Charset.forName("UTF-8");
 362
 363         public static String string(int[] bytes, int s, int l) {
 364                 if (s + l > bytes.length) {
 365                         if (s > bytes.length) {
 366                                 s = bytes.length;
 367                                 l = 0;
 368                         } else {
 369                                 l = bytes.length - s;
 370                         }
 371                 }
 372
 373                 int i;
 374                 for (i = l - 1; i >= 0; i--)
 375                         if (bytes[s+i] != 0)
 376                                 break;
 377
 378                 l = i + 1;
 379                 byte[]  b = new byte[l];
 380
 381                 for (i = 0; i < l; i++)
 382                         b[i] = (byte) bytes[s+i];
 383                 String n = new String(b, unicode_set);
 384                 return n;
 385         }
 386
 387         public static int hexbyte(String s, int i) {
 388                 int c0, c1;
 389
 390                 if (s.length() < i + 2)
 391                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 392                 c0 = s.charAt(i);
 393                 if (!ishex(c0))
 394                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c0));
 395                 c1 = s.charAt(i+1);
 396                 if (!ishex(c1))
 397                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c1));
 398                 return fromhex(c0) * 16 + fromhex(c1);
 399         }
 400
 401         public static int[] hexbytes(String s) {
 402                 int     n;
 403                 int[]   r;
 404                 int     i;
 405
 406                 if ((s.length() & 1) != 0)
 407                         throw new NumberFormatException(String.format("invalid line \"%s\"", s));
 408                 n = s.length() / 2;
 409                 r = new int[n];
 410                 for (i = 0; i < n; i++)
 411                         r[i] = hexbyte(s, i * 2);
 412                 return r;
 413         }
 414
 415         public static int fromdec(String s) throws NumberFormatException {
 416                 int c, v = 0;
 417                 int sign = 1;
 418                 for (int i = 0; i < s.length(); i++) {
 419                         c = s.charAt(i);
 420                         if (i == 0 && c == '-') {
 421                                 sign = -1;
 422                         } else if (!isdec(c)) {
 423                                 if (i == 0)
 424                                         throw new NumberFormatException(String.format("invalid number \"%s\"", s));
 425                                 return v;
 426                         } else
 427                                 v = v * 10 + fromdec(c);
 428                 }
 429                 return v * sign;
 430         }
 431
 432         public static String gets(FileInputStream s) throws IOException {
 433                 int c;
 434                 String  line = "";
 435
 436                 while ((c = s.read()) != -1) {
 437                         if (c == '\r')
 438                                 continue;
 439                         if (c == '\n') {
 440                                 return line;
 441                         }
 442                         line = line + (char) c;
 443                 }
 444                 return null;
 445         }
 446
 447         public static String replace_extension(String input, String extension) {
 448                 int dot = input.lastIndexOf(".");
 449                 if (dot > 0)
 450                         input = input.substring(0,dot);
 451                 return input.concat(extension);
 452         }
 453
 454         public static File replace_extension(File input, String extension) {
 455                 return new File(replace_extension(input.getPath(), extension));
 456         }
 457
 458         public static String product_name(int product_id) {
 459                 switch (product_id) {
 460                 case product_altusmetrum: return "AltusMetrum";
 461                 case product_telemetrum: return "TeleMetrum";
 462                 case product_teledongle: return "TeleDongle";
 463                 case product_teleterra: return "TeleTerra";
 464                 case product_telebt: return "TeleBT";
 465                 case product_telelaunch: return "TeleLaunch";
 466                 case product_telelco: return "TeleLco";
 467                 case product_telescience: return "Telescience";
 468                 case product_telepyro: return "TelePyro";
 469                 case product_telemega: return "TeleMega";
 470                 case product_megadongle: return "MegaDongle";
 471                 case product_telegps: return "TeleGPS";
 472                 case product_easymini: return "EasyMini";
 473                 case product_telemini: return "TeleMini";
 474                 default: return "unknown";
 475                 }
 476         }
 477 }