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_1;
  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_TIME = 'G';
  32         public static final int AO_LOG_GPS_LAT = 'N';
  33         public static final int AO_LOG_GPS_LON = 'W';
  34         public static final int AO_LOG_GPS_ALT = 'H';
  35         public static final int AO_LOG_GPS_SAT = 'V';
  36         public static final int AO_LOG_GPS_DATE = 'Y';
  37         public static final int AO_LOG_PRESSURE = 'P';
  38
  39         /* Added for header fields in eeprom files */
  40         public static final int AO_LOG_CONFIG_VERSION = 1000;
  41         public static final int AO_LOG_MAIN_DEPLOY = 1001;
  42         public static final int AO_LOG_APOGEE_DELAY = 1002;
  43         public static final int AO_LOG_RADIO_CHANNEL = 1003;
  44         public static final int AO_LOG_CALLSIGN = 1004;
  45         public static final int AO_LOG_ACCEL_CAL = 1005;
  46         public static final int AO_LOG_RADIO_CAL = 1006;
  47         public static final int AO_LOG_MAX_FLIGHT_LOG = 1007;
  48         public static final int AO_LOG_MANUFACTURER = 2000;
  49         public static final int AO_LOG_PRODUCT = 2001;
  50         public static final int AO_LOG_SERIAL_NUMBER = 2002;
  51         public static final int AO_LOG_LOG_FORMAT = 2003;
  52
  53         /* Added for header fields in megametrum files */
  54         public static final int AO_LOG_BARO_RESERVED = 3000;
  55         public static final int AO_LOG_BARO_SENS = 3001;
  56         public static final int AO_LOG_BARO_OFF = 3002;
  57         public static final int AO_LOG_BARO_TCS = 3004;
  58         public static final int AO_LOG_BARO_TCO = 3005;
  59         public static final int AO_LOG_BARO_TREF = 3006;
  60         public static final int AO_LOG_BARO_TEMPSENS = 3007;
  61         public static final int AO_LOG_BARO_CRC = 3008;
  62
  63         public static final int AO_LOG_SOFTWARE_VERSION = 9999;
  64
  65         /* Added to flag invalid records */
  66         public static final int AO_LOG_INVALID = -1;
  67
  68         /* Flight state numbers and names */
  69         public static final int ao_flight_startup = 0;
  70         public static final int ao_flight_idle = 1;
  71         public static final int ao_flight_pad = 2;
  72         public static final int ao_flight_boost = 3;
  73         public static final int ao_flight_fast = 4;
  74         public static final int ao_flight_coast = 5;
  75         public static final int ao_flight_drogue = 6;
  76         public static final int ao_flight_main = 7;
  77         public static final int ao_flight_landed = 8;
  78         public static final int ao_flight_invalid = 9;
  79
  80         /* USB product IDs */
  81         public final static int vendor_altusmetrum = 0xfffe;
  82
  83         public final static int product_altusmetrum = 0x000a;
  84         public final static int product_telemetrum = 0x000b;
  85         public final static int product_teledongle = 0x000c;
  86         public final static int product_teleterra = 0x000d;
  87         public final static int product_telebt = 0x000e;
  88         public final static int product_telelaunch = 0x000f;
  89         public final static int product_telelco = 0x0010;
  90         public final static int product_telescience = 0x0011;
  91         public final static int product_telepyro =0x0012;
  92         public final static int product_megametrum = 0x0023;
  93         public final static int product_megadongle = 0x0024;
  94         public final static int product_altusmetrum_min = 0x000a;
  95         public final static int product_altusmetrum_max = 0x0024;
  96
  97         public final static int product_any = 0x10000;
  98         public final static int product_basestation = 0x10000 + 1;
  99         public final static int product_altimeter = 0x10000 + 2;
 100
 101         /* Bluetooth "identifier" (bluetooth sucks) */
 102         public final static String bt_product_telebt = "TeleBT";
 103
 104         /* Telemetry modes */
 105         public static final int ao_telemetry_off = 0;
 106         public static final int ao_telemetry_min = 1;
 107         public static final int ao_telemetry_standard = 1;
 108         public static final int ao_telemetry_0_9 = 2;
 109         public static final int ao_telemetry_0_8 = 3;
 110         public static final int ao_telemetry_max = 3;
 111
 112         private static final String[] ao_telemetry_name = {
 113                 "Off", "Standard Telemetry", "TeleMetrum v0.9", "TeleMetrum v0.8"
 114         };
 115
 116         public static final String launch_sites_url = "http://www.altusmetrum.org/AltOS/launch-sites.txt";
 117
 118         public static final int ao_telemetry_standard_len = 32;
 119         public static final int ao_telemetry_0_9_len = 95;
 120         public static final int ao_telemetry_0_8_len = 94;
 121
 122         private static final int[] ao_telemetry_len = {
 123                 0, 32, 95, 94
 124         };
 125
 126         private static HashMap<String,Integer>  string_to_state = new HashMap<String,Integer>();
 127
 128         private static boolean map_initialized = false;
 129
 130         public static void initialize_map()
 131         {
 132                 string_to_state.put("startup", ao_flight_startup);
 133                 string_to_state.put("idle", ao_flight_idle);
 134                 string_to_state.put("pad", ao_flight_pad);
 135                 string_to_state.put("boost", ao_flight_boost);
 136                 string_to_state.put("fast", ao_flight_fast);
 137                 string_to_state.put("coast", ao_flight_coast);
 138                 string_to_state.put("drogue", ao_flight_drogue);
 139                 string_to_state.put("apogee", ao_flight_coast);
 140                 string_to_state.put("main", ao_flight_main);
 141                 string_to_state.put("landed", ao_flight_landed);
 142                 string_to_state.put("invalid", ao_flight_invalid);
 143                 map_initialized = true;
 144         }
 145
 146         public static int telemetry_len(int telemetry) {
 147                 if (telemetry <= ao_telemetry_max)
 148                         return ao_telemetry_len[telemetry];
 149                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 150                                                                  telemetry));
 151         }
 152
 153         public static String telemetry_name(int telemetry) {
 154                 if (telemetry <= ao_telemetry_max)
 155                         return ao_telemetry_name[telemetry];
 156                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 157                                                                  telemetry));
 158         }
 159
 160         private static String[] state_to_string = {
 161                 "startup",
 162                 "idle",
 163                 "pad",
 164                 "boost",
 165                 "fast",
 166                 "coast",
 167                 "drogue",
 168                 "main",
 169                 "landed",
 170                 "invalid",
 171         };
 172
 173         private static String[] state_to_string_capital = {
 174                 "Startup",
 175                 "Idle",
 176                 "Pad",
 177                 "Boost",
 178                 "Fast",
 179                 "Coast",
 180                 "Drogue",
 181                 "Main",
 182                 "Landed",
 183                 "Invalid",
 184         };
 185
 186         public static int state(String state) {
 187                 if (!map_initialized)
 188                         initialize_map();
 189                 if (string_to_state.containsKey(state))
 190                         return string_to_state.get(state);
 191                 return ao_flight_invalid;
 192         }
 193
 194         public static String state_name(int state) {
 195                 if (state < 0 || state_to_string.length <= state)
 196                         return "invalid";
 197                 return state_to_string[state];
 198         }
 199
 200         public static String state_name_capital(int state) {
 201                 if (state < 0 || state_to_string.length <= state)
 202                         return "Invalid";
 203                 return state_to_string_capital[state];
 204         }
 205
 206         public static final int AO_GPS_VALID = (1 << 4);
 207         public static final int AO_GPS_RUNNING = (1 << 5);
 208         public static final int AO_GPS_DATE_VALID = (1 << 6);
 209         public static final int AO_GPS_NUM_SAT_SHIFT = 0;
 210         public static final int AO_GPS_NUM_SAT_MASK = 0xf;
 211
 212         public static final int AO_LOG_FORMAT_UNKNOWN = 0;
 213         public static final int AO_LOG_FORMAT_FULL = 1;
 214         public static final int AO_LOG_FORMAT_TINY = 2;
 215         public static final int AO_LOG_FORMAT_TELEMETRY = 3;
 216         public static final int AO_LOG_FORMAT_TELESCIENCE = 4;
 217         public static final int AO_LOG_FORMAT_MEGAMETRUM = 5;
 218         public static final int AO_LOG_FORMAT_NONE = 127;
 219
 220         public static boolean isspace(int c) {
 221                 switch (c) {
 222                 case ' ':
 223                 case '\t':
 224                         return true;
 225                 }
 226                 return false;
 227         }
 228
 229         public static boolean ishex(int c) {
 230                 if ('0' <= c && c <= '9')
 231                         return true;
 232                 if ('a' <= c && c <= 'f')
 233                         return true;
 234                 if ('A' <= c && c <= 'F')
 235                         return true;
 236                 return false;
 237         }
 238
 239         public static boolean ishex(String s) {
 240                 for (int i = 0; i < s.length(); i++)
 241                         if (!ishex(s.charAt(i)))
 242                                 return false;
 243                 return true;
 244         }
 245
 246         public static int fromhex(int c) {
 247                 if ('0' <= c && c <= '9')
 248                         return c - '0';
 249                 if ('a' <= c && c <= 'f')
 250                         return c - 'a' + 10;
 251                 if ('A' <= c && c <= 'F')
 252                         return c - 'A' + 10;
 253                 return -1;
 254         }
 255
 256         public static int fromhex(String s) throws NumberFormatException {
 257                 int c, v = 0;
 258                 for (int i = 0; i < s.length(); i++) {
 259                         c = s.charAt(i);
 260                         if (!ishex(c)) {
 261                                 if (i == 0)
 262                                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 263                                 return v;
 264                         }
 265                         v = v * 16 + fromhex(c);
 266                 }
 267                 return v;
 268         }
 269
 270         public static boolean isdec(int c) {
 271                 if ('0' <= c && c <= '9')
 272                         return true;
 273                 return false;
 274         }
 275
 276         public static boolean isdec(String s) {
 277                 for (int i = 0; i < s.length(); i++)
 278                         if (!isdec(s.charAt(i)))
 279                                 return false;
 280                 return true;
 281         }
 282
 283         public static int fromdec(int c) {
 284                 if ('0' <= c && c <= '9')
 285                         return c - '0';
 286                 return -1;
 287         }
 288
 289         public static int int8(int[] bytes, int i) {
 290                 return (int) (byte) bytes[i];
 291         }
 292
 293         public static int uint8(int[] bytes, int i) {
 294                 return bytes[i];
 295         }
 296
 297         public static int int16(int[] bytes, int i) {
 298                 return (int) (short) (bytes[i] + (bytes[i+1] << 8));
 299         }
 300
 301         public static int uint16(int[] bytes, int i) {
 302                 return bytes[i] + (bytes[i+1] << 8);
 303         }
 304
 305         public static int uint32(int[] bytes, int i) {
 306                 return bytes[i] +
 307                         (bytes[i+1] << 8) +
 308                         (bytes[i+2] << 16) +
 309                         (bytes[i+3] << 24);
 310         }
 311
 312         public static int int32(int[] bytes, int i) {
 313                 return (int) uint32(bytes, i);
 314         }
 315
 316         public static final Charset     unicode_set = Charset.forName("UTF-8");
 317
 318         public static String string(int[] bytes, int s, int l) {
 319                 if (s + l > bytes.length) {
 320                         if (s > bytes.length) {
 321                                 s = bytes.length;
 322                                 l = 0;
 323                         } else {
 324                                 l = bytes.length - s;
 325                         }
 326                 }
 327
 328                 int i;
 329                 for (i = l - 1; i >= 0; i--)
 330                         if (bytes[s+i] != 0)
 331                                 break;
 332
 333                 l = i + 1;
 334                 byte[]  b = new byte[l];
 335
 336                 for (i = 0; i < l; i++)
 337                         b[i] = (byte) bytes[s+i];
 338                 String n = new String(b, unicode_set);
 339                 return n;
 340         }
 341
 342         public static int hexbyte(String s, int i) {
 343                 int c0, c1;
 344
 345                 if (s.length() < i + 2)
 346                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 347                 c0 = s.charAt(i);
 348                 if (!ishex(c0))
 349                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c0));
 350                 c1 = s.charAt(i+1);
 351                 if (!ishex(c1))
 352                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c1));
 353                 return fromhex(c0) * 16 + fromhex(c1);
 354         }
 355
 356         public static int[] hexbytes(String s) {
 357                 int     n;
 358                 int[]   r;
 359                 int     i;
 360
 361                 if ((s.length() & 1) != 0)
 362                         throw new NumberFormatException(String.format("invalid line \"%s\"", s));
 363                 n = s.length() / 2;
 364                 r = new int[n];
 365                 for (i = 0; i < n; i++)
 366                         r[i] = hexbyte(s, i * 2);
 367                 return r;
 368         }
 369
 370         public static int fromdec(String s) throws NumberFormatException {
 371                 int c, v = 0;
 372                 int sign = 1;
 373                 for (int i = 0; i < s.length(); i++) {
 374                         c = s.charAt(i);
 375                         if (i == 0 && c == '-') {
 376                                 sign = -1;
 377                         } else if (!isdec(c)) {
 378                                 if (i == 0)
 379                                         throw new NumberFormatException(String.format("invalid number \"%s\"", s));
 380                                 return v;
 381                         } else
 382                                 v = v * 10 + fromdec(c);
 383                 }
 384                 return v * sign;
 385         }
 386
 387         public static String gets(FileInputStream s) throws IOException {
 388                 int c;
 389                 String  line = "";
 390
 391                 while ((c = s.read()) != -1) {
 392                         if (c == '\r')
 393                                 continue;
 394                         if (c == '\n') {
 395                                 return line;
 396                         }
 397                         line = line + (char) c;
 398                 }
 399                 return null;
 400         }
 401
 402         public static String replace_extension(String input, String extension) {
 403                 int dot = input.lastIndexOf(".");
 404                 if (dot > 0)
 405                         input = input.substring(0,dot);
 406                 return input.concat(extension);
 407         }
 408
 409         public static File replace_extension(File input, String extension) {
 410                 return new File(replace_extension(input.getPath(), extension));
 411         }
 412 }