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 telemega 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_telemega = 0x0023;
  93         public final static int product_megadongle = 0x0024;
  94         public final static int product_telegps = 0x0025;
  95         public final static int product_altusmetrum_min = 0x000a;
  96         public final static int product_altusmetrum_max = 0x0025;
  97
  98         public final static int product_any = 0x10000;
  99         public final static int product_basestation = 0x10000 + 1;
 100         public final static int product_altimeter = 0x10000 + 2;
 101
 102         /* Bluetooth "identifier" (bluetooth sucks) */
 103         public final static String bt_product_telebt = "TeleBT";
 104
 105         /* Telemetry modes */
 106         public static final int ao_telemetry_off = 0;
 107         public static final int ao_telemetry_min = 1;
 108         public static final int ao_telemetry_standard = 1;
 109         public static final int ao_telemetry_0_9 = 2;
 110         public static final int ao_telemetry_0_8 = 3;
 111         public static final int ao_telemetry_max = 3;
 112
 113         private static final String[] ao_telemetry_name = {
 114                 "Off", "Standard Telemetry", "TeleMetrum v0.9", "TeleMetrum v0.8"
 115         };
 116
 117         public static final String launch_sites_url = "http://www.altusmetrum.org/AltOS/launch-sites.txt";
 118
 119         public static final int ao_telemetry_standard_len = 32;
 120         public static final int ao_telemetry_0_9_len = 95;
 121         public static final int ao_telemetry_0_8_len = 94;
 122
 123         private static final int[] ao_telemetry_len = {
 124                 0, 32, 95, 94
 125         };
 126
 127         private static HashMap<String,Integer>  string_to_state = new HashMap<String,Integer>();
 128
 129         private static boolean map_initialized = false;
 130
 131         public static void initialize_map()
 132         {
 133                 string_to_state.put("startup", ao_flight_startup);
 134                 string_to_state.put("idle", ao_flight_idle);
 135                 string_to_state.put("pad", ao_flight_pad);
 136                 string_to_state.put("boost", ao_flight_boost);
 137                 string_to_state.put("fast", ao_flight_fast);
 138                 string_to_state.put("coast", ao_flight_coast);
 139                 string_to_state.put("drogue", ao_flight_drogue);
 140                 string_to_state.put("apogee", ao_flight_coast);
 141                 string_to_state.put("main", ao_flight_main);
 142                 string_to_state.put("landed", ao_flight_landed);
 143                 string_to_state.put("invalid", ao_flight_invalid);
 144                 map_initialized = true;
 145         }
 146
 147         public static int telemetry_len(int telemetry) {
 148                 if (telemetry <= ao_telemetry_max)
 149                         return ao_telemetry_len[telemetry];
 150                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 151                                                                  telemetry));
 152         }
 153
 154         public static String telemetry_name(int telemetry) {
 155                 if (telemetry <= ao_telemetry_max)
 156                         return ao_telemetry_name[telemetry];
 157                 throw new IllegalArgumentException(String.format("Invalid telemetry %d",
 158                                                                  telemetry));
 159         }
 160
 161         private static String[] state_to_string = {
 162                 "startup",
 163                 "idle",
 164                 "pad",
 165                 "boost",
 166                 "fast",
 167                 "coast",
 168                 "drogue",
 169                 "main",
 170                 "landed",
 171                 "invalid",
 172         };
 173
 174         private static String[] state_to_string_capital = {
 175                 "Startup",
 176                 "Idle",
 177                 "Pad",
 178                 "Boost",
 179                 "Fast",
 180                 "Coast",
 181                 "Drogue",
 182                 "Main",
 183                 "Landed",
 184                 "Invalid",
 185         };
 186
 187         public static int state(String state) {
 188                 if (!map_initialized)
 189                         initialize_map();
 190                 if (string_to_state.containsKey(state))
 191                         return string_to_state.get(state);
 192                 return ao_flight_invalid;
 193         }
 194
 195         public static String state_name(int state) {
 196                 if (state < 0 || state_to_string.length <= state)
 197                         return "invalid";
 198                 return state_to_string[state];
 199         }
 200
 201         public static String state_name_capital(int state) {
 202                 if (state < 0 || state_to_string.length <= state)
 203                         return "Invalid";
 204                 return state_to_string_capital[state];
 205         }
 206
 207         public static final int AO_GPS_VALID = (1 << 4);
 208         public static final int AO_GPS_RUNNING = (1 << 5);
 209         public static final int AO_GPS_DATE_VALID = (1 << 6);
 210         public static final int AO_GPS_NUM_SAT_SHIFT = 0;
 211         public static final int AO_GPS_NUM_SAT_MASK = 0xf;
 212
 213         public static final int AO_LOG_FORMAT_UNKNOWN = 0;
 214         public static final int AO_LOG_FORMAT_FULL = 1;
 215         public static final int AO_LOG_FORMAT_TINY = 2;
 216         public static final int AO_LOG_FORMAT_TELEMETRY = 3;
 217         public static final int AO_LOG_FORMAT_TELESCIENCE = 4;
 218         public static final int AO_LOG_FORMAT_TELEMEGA = 5;
 219         public static final int AO_LOG_FORMAT_MINI = 6;
 220         public static final int AO_LOG_FORMAT_NONE = 127;
 221
 222         public static boolean isspace(int c) {
 223                 switch (c) {
 224                 case ' ':
 225                 case '\t':
 226                         return true;
 227                 }
 228                 return false;
 229         }
 230
 231         public static boolean ishex(int c) {
 232                 if ('0' <= c && c <= '9')
 233                         return true;
 234                 if ('a' <= c && c <= 'f')
 235                         return true;
 236                 if ('A' <= c && c <= 'F')
 237                         return true;
 238                 return false;
 239         }
 240
 241         public static boolean ishex(String s) {
 242                 for (int i = 0; i < s.length(); i++)
 243                         if (!ishex(s.charAt(i)))
 244                                 return false;
 245                 return true;
 246         }
 247
 248         public static int fromhex(int c) {
 249                 if ('0' <= c && c <= '9')
 250                         return c - '0';
 251                 if ('a' <= c && c <= 'f')
 252                         return c - 'a' + 10;
 253                 if ('A' <= c && c <= 'F')
 254                         return c - 'A' + 10;
 255                 return -1;
 256         }
 257
 258         public static int fromhex(String s) throws NumberFormatException {
 259                 int c, v = 0;
 260                 for (int i = 0; i < s.length(); i++) {
 261                         c = s.charAt(i);
 262                         if (!ishex(c)) {
 263                                 if (i == 0)
 264                                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 265                                 return v;
 266                         }
 267                         v = v * 16 + fromhex(c);
 268                 }
 269                 return v;
 270         }
 271
 272         public static boolean isdec(int c) {
 273                 if ('0' <= c && c <= '9')
 274                         return true;
 275                 return false;
 276         }
 277
 278         public static boolean isdec(String s) {
 279                 for (int i = 0; i < s.length(); i++)
 280                         if (!isdec(s.charAt(i)))
 281                                 return false;
 282                 return true;
 283         }
 284
 285         public static int fromdec(int c) {
 286                 if ('0' <= c && c <= '9')
 287                         return c - '0';
 288                 return -1;
 289         }
 290
 291         public static int int8(int[] bytes, int i) {
 292                 return (int) (byte) bytes[i];
 293         }
 294
 295         public static int uint8(int[] bytes, int i) {
 296                 return bytes[i];
 297         }
 298
 299         public static int int16(int[] bytes, int i) {
 300                 return (int) (short) (bytes[i] + (bytes[i+1] << 8));
 301         }
 302
 303         public static int uint16(int[] bytes, int i) {
 304                 return bytes[i] + (bytes[i+1] << 8);
 305         }
 306
 307         public static int uint32(int[] bytes, int i) {
 308                 return bytes[i] +
 309                         (bytes[i+1] << 8) +
 310                         (bytes[i+2] << 16) +
 311                         (bytes[i+3] << 24);
 312         }
 313
 314         public static int int32(int[] bytes, int i) {
 315                 return (int) uint32(bytes, i);
 316         }
 317
 318         public static final Charset     unicode_set = Charset.forName("UTF-8");
 319
 320         public static String string(int[] bytes, int s, int l) {
 321                 if (s + l > bytes.length) {
 322                         if (s > bytes.length) {
 323                                 s = bytes.length;
 324                                 l = 0;
 325                         } else {
 326                                 l = bytes.length - s;
 327                         }
 328                 }
 329
 330                 int i;
 331                 for (i = l - 1; i >= 0; i--)
 332                         if (bytes[s+i] != 0)
 333                                 break;
 334
 335                 l = i + 1;
 336                 byte[]  b = new byte[l];
 337
 338                 for (i = 0; i < l; i++)
 339                         b[i] = (byte) bytes[s+i];
 340                 String n = new String(b, unicode_set);
 341                 return n;
 342         }
 343
 344         public static int hexbyte(String s, int i) {
 345                 int c0, c1;
 346
 347                 if (s.length() < i + 2)
 348                         throw new NumberFormatException(String.format("invalid hex \"%s\"", s));
 349                 c0 = s.charAt(i);
 350                 if (!ishex(c0))
 351                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c0));
 352                 c1 = s.charAt(i+1);
 353                 if (!ishex(c1))
 354                         throw new NumberFormatException(String.format("invalid hex \"%c\"", c1));
 355                 return fromhex(c0) * 16 + fromhex(c1);
 356         }
 357
 358         public static int[] hexbytes(String s) {
 359                 int     n;
 360                 int[]   r;
 361                 int     i;
 362
 363                 if ((s.length() & 1) != 0)
 364                         throw new NumberFormatException(String.format("invalid line \"%s\"", s));
 365                 n = s.length() / 2;
 366                 r = new int[n];
 367                 for (i = 0; i < n; i++)
 368                         r[i] = hexbyte(s, i * 2);
 369                 return r;
 370         }
 371
 372         public static int fromdec(String s) throws NumberFormatException {
 373                 int c, v = 0;
 374                 int sign = 1;
 375                 for (int i = 0; i < s.length(); i++) {
 376                         c = s.charAt(i);
 377                         if (i == 0 && c == '-') {
 378                                 sign = -1;
 379                         } else if (!isdec(c)) {
 380                                 if (i == 0)
 381                                         throw new NumberFormatException(String.format("invalid number \"%s\"", s));
 382                                 return v;
 383                         } else
 384                                 v = v * 10 + fromdec(c);
 385                 }
 386                 return v * sign;
 387         }
 388
 389         public static String gets(FileInputStream s) throws IOException {
 390                 int c;
 391                 String  line = "";
 392
 393                 while ((c = s.read()) != -1) {
 394                         if (c == '\r')
 395                                 continue;
 396                         if (c == '\n') {
 397                                 return line;
 398                         }
 399                         line = line + (char) c;
 400                 }
 401                 return null;
 402         }
 403
 404         public static String replace_extension(String input, String extension) {
 405                 int dot = input.lastIndexOf(".");
 406                 if (dot > 0)
 407                         input = input.substring(0,dot);
 408                 return input.concat(extension);
 409         }
 410
 411         public static File replace_extension(File input, String extension) {
 412                 return new File(replace_extension(input.getPath(), extension));
 413         }
 414 }