git.gag.com Git - fw/altos/blob - ao-tools/lib/cc-telemetry.h

   1 /*
   2  * Copyright © 2011 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 #ifndef _CC_TELEMETRY_H_
  20 #define _CC_TELEMETRY_H_
  21 /*
  22  * ao_telemetry.c
  23  */
  24 #define AO_MAX_CALLSIGN                 8
  25 #define AO_MAX_VERSION                  8
  26 #define AO_MAX_TELEMETRY                128
  27
  28 struct ao_telemetry_generic {
  29         uint16_t        serial;         /* 0 */
  30         uint16_t        tick;           /* 2 */
  31         uint8_t         type;           /* 4 */
  32         uint8_t         payload[27];    /* 5 */
  33         uint8_t         rssi;           /* 32 */
  34         uint8_t         status;         /* 33 */
  35         /* 34 */
  36 };
  37
  38 #define AO_TELEMETRY_SENSOR_TELEMETRUM  0x01
  39 #define AO_TELEMETRY_SENSOR_TELEMINI    0x02
  40 #define AO_TELEMETRY_SENSOR_TELENANO    0x03
  41
  42 struct ao_telemetry_sensor {
  43         uint16_t        serial;         /*  0 */
  44         uint16_t        tick;           /*  2 */
  45         uint8_t         type;           /*  4 */
  46
  47         uint8_t         state;          /*  5 flight state */
  48         int16_t         accel;          /*  6 accelerometer (TM only) */
  49         int16_t         pres;           /*  8 pressure sensor */
  50         int16_t         temp;           /* 10 temperature sensor */
  51         int16_t         v_batt;         /* 12 battery voltage */
  52         int16_t         sense_d;        /* 14 drogue continuity sense (TM/Tm) */
  53         int16_t         sense_m;        /* 16 main continuity sense (TM/Tm) */
  54
  55         int16_t         acceleration;   /* 18 m/s² * 16 */
  56         int16_t         speed;          /* 20 m/s * 16 */
  57         int16_t         height;         /* 22 m */
  58
  59         int16_t         ground_pres;    /* 24 average pres on pad */
  60         int16_t         ground_accel;   /* 26 average accel on pad */
  61         int16_t         accel_plus_g;   /* 28 accel calibration at +1g */
  62         int16_t         accel_minus_g;  /* 30 accel calibration at -1g */
  63         /* 32 */
  64 };
  65
  66 #define AO_TELEMETRY_CONFIGURATION      0x04
  67
  68 struct ao_telemetry_configuration {
  69         uint16_t        serial;                         /*  0 */
  70         uint16_t        tick;                           /*  2 */
  71         uint8_t         type;                           /*  4 */
  72
  73         uint8_t         device;                         /*  5 device type */
  74         uint16_t        flight;                         /*  6 flight number */
  75         uint8_t         config_major;                   /*  8 Config major version */
  76         uint8_t         config_minor;                   /*  9 Config minor version */
  77         uint16_t        apogee_delay;                   /* 10 Apogee deploy delay in seconds */
  78         uint16_t        main_deploy;                    /* 12 Main deploy alt in meters */
  79         uint16_t        flight_log_max;                 /* 14 Maximum flight log size in kB */
  80         char            callsign[AO_MAX_CALLSIGN];      /* 16 Radio operator identity */
  81         char            version[AO_MAX_VERSION];        /* 24 Software version */
  82         /* 32 */
  83 };
  84
  85 #define AO_TELEMETRY_LOCATION           0x05
  86
  87 #define AO_GPS_MODE_NOT_VALID           'N'
  88 #define AO_GPS_MODE_AUTONOMOUS          'A'
  89 #define AO_GPS_MODE_DIFFERENTIAL        'D'
  90 #define AO_GPS_MODE_ESTIMATED           'E'
  91 #define AO_GPS_MODE_MANUAL              'M'
  92 #define AO_GPS_MODE_SIMULATED           'S'
  93
  94 struct ao_telemetry_location {
  95         uint16_t        serial;         /*  0 */
  96         uint16_t        tick;           /*  2 */
  97         uint8_t         type;           /*  4 */
  98
  99         uint8_t         flags;          /*  5 Number of sats and other flags */
 100         int16_t         altitude;       /*  6 GPS reported altitude (m) */
 101         int32_t         latitude;       /*  8 latitude (degrees * 10⁷) */
 102         int32_t         longitude;      /* 12 longitude (degrees * 10⁷) */
 103         uint8_t         year;           /* 16 (- 2000) */
 104         uint8_t         month;          /* 17 (1-12) */
 105         uint8_t         day;            /* 18 (1-31) */
 106         uint8_t         hour;           /* 19 (0-23) */
 107         uint8_t         minute;         /* 20 (0-59) */
 108         uint8_t         second;         /* 21 (0-59) */
 109         uint8_t         pdop;           /* 22 (m * 5) */
 110         uint8_t         hdop;           /* 23 (m * 5) */
 111         uint8_t         vdop;           /* 24 (m * 5) */
 112         uint8_t         mode;           /* 25 */
 113         uint16_t        ground_speed;   /* 26 cm/s */
 114         int16_t         climb_rate;     /* 28 cm/s */
 115         uint8_t         course;         /* 30 degrees / 2 */
 116         uint8_t         unused[1];      /* 31 */
 117         /* 32 */
 118 };
 119
 120 #define AO_TELEMETRY_SATELLITE          0x06
 121
 122 struct ao_telemetry_satellite_info {
 123         uint8_t         svid;
 124         uint8_t         c_n_1;
 125 };
 126
 127 struct ao_telemetry_satellite {
 128         uint16_t                                serial;         /*  0 */
 129         uint16_t                                tick;           /*  2 */
 130         uint8_t                                 type;           /*  4 */
 131         uint8_t                                 channels;       /*  5 number of reported sats */
 132
 133         struct ao_telemetry_satellite_info      sats[12];       /* 6 */
 134         uint8_t                                 unused[2];      /* 30 */
 135         /* 32 */
 136 };
 137
 138 #define AO_TELEMETRY_COMPANION          0x07
 139
 140 #define AO_COMPANION_MAX_CHANNELS       12
 141
 142 struct ao_telemetry_companion {
 143         uint16_t                                serial;         /*  0 */
 144         uint16_t                                tick;           /*  2 */
 145         uint8_t                                 type;           /*  4 */
 146         uint8_t                                 board_id;       /*  5 */
 147
 148         uint8_t                                 update_period;  /*  6 */
 149         uint8_t                                 channels;       /*  7 */
 150         uint16_t                                companion_data[AO_COMPANION_MAX_CHANNELS];      /*  8 */
 151         /* 32 */
 152 };
 153
 154 #define AO_TELEMETRY_MEGA_SENSOR        0x08
 155
 156 struct ao_telemetry_mega_sensor {
 157         uint16_t        serial;         /*  0 */
 158         uint16_t        tick;           /*  2 */
 159         uint8_t         type;           /*  4 */
 160
 161         uint8_t         orient;         /*  5 angle from vertical */
 162         int16_t         accel;          /*  6 Z axis */
 163
 164         int32_t         pres;           /*  8 Pa * 10 */
 165         int16_t         temp;           /* 12 °C * 100 */
 166
 167         int16_t         accel_x;        /* 14 */
 168         int16_t         accel_y;        /* 16 */
 169         int16_t         accel_z;        /* 18 */
 170
 171         int16_t         gyro_x;         /* 20 */
 172         int16_t         gyro_y;         /* 22 */
 173         int16_t         gyro_z;         /* 24 */
 174
 175         int16_t         mag_x;          /* 26 */
 176         int16_t         mag_y;          /* 28 */
 177         int16_t         mag_z;          /* 30 */
 178         /* 32 */
 179 };
 180
 181 #define AO_TELEMETRY_MEGA_DATA          0x09
 182
 183 struct ao_telemetry_mega_data {
 184         uint16_t        serial;         /*  0 */
 185         uint16_t        tick;           /*  2 */
 186         uint8_t         type;           /*  4 */
 187
 188         uint8_t         state;          /*  5 flight state */
 189
 190         int16_t         v_batt;         /*  6 battery voltage */
 191         int16_t         v_pyro;         /*  8 pyro battery voltage */
 192         int8_t          sense[6];       /* 10 continuity sense */
 193
 194         int32_t         ground_pres;    /* 16 average pres on pad */
 195         int16_t         ground_accel;   /* 20 average accel on pad */
 196         int16_t         accel_plus_g;   /* 22 accel calibration at +1g */
 197         int16_t         accel_minus_g;  /* 24 accel calibration at -1g */
 198
 199         int16_t         acceleration;   /* 26 m/s² * 16 */
 200         int16_t         speed;          /* 28 m/s * 16 */
 201         int16_t         height;         /* 30 m */
 202         /* 32 */
 203 };
 204
 205 #define AO_TELEMETRY_METRUM_SENSOR      0x0A
 206
 207 struct ao_telemetry_metrum_sensor {
 208         uint16_t        serial;         /*  0 */
 209         uint16_t        tick;           /*  2 */
 210         uint8_t         type;           /*  4 */
 211
 212         uint8_t         state;          /*  5 flight state */
 213         int16_t         accel;          /*  6 Z axis */
 214
 215         int32_t         pres;           /*  8 Pa * 10 */
 216         int16_t         temp;           /* 12 °C * 100 */
 217
 218         int16_t         acceleration;   /* 14 m/s² * 16 */
 219         int16_t         speed;          /* 16 m/s * 16 */
 220         int16_t         height;         /* 18 m */
 221
 222         int16_t         v_batt;         /* 20 battery voltage */
 223         int16_t         sense_a;        /* 22 apogee continuity sense */
 224         int16_t         sense_m;        /* 24 main continuity sense */
 225
 226         uint8_t         pad[6];         /* 26 */
 227         /* 32 */
 228 };
 229
 230 #define AO_TELEMETRY_METRUM_DATA        0x0B
 231
 232 struct ao_telemetry_metrum_data {
 233         uint16_t        serial;         /*  0 */
 234         uint16_t        tick;           /*  2 */
 235         uint8_t         type;           /*  4 */
 236
 237         int32_t         ground_pres;    /* 8 average pres on pad */
 238         int16_t         ground_accel;   /* 12 average accel on pad */
 239         int16_t         accel_plus_g;   /* 14 accel calibration at +1g */
 240         int16_t         accel_minus_g;  /* 16 accel calibration at -1g */
 241
 242         uint8_t         pad[14];        /* 18 */
 243         /* 32 */
 244 };
 245
 246 #define AO_TELEMETRY_MINI               0x10
 247
 248 struct ao_telemetry_mini {
 249         uint16_t        serial;         /*  0 */
 250         uint16_t        tick;           /*  2 */
 251         uint8_t         type;           /*  4 */
 252
 253         uint8_t         state;          /*  5 flight state */
 254         int16_t         v_batt;         /*  6 battery voltage */
 255         int16_t         sense_a;        /*  8 apogee continuity */
 256         int16_t         sense_m;        /* 10 main continuity */
 257
 258         int32_t         pres;           /* 12 Pa * 10 */
 259         int16_t         temp;           /* 16 °C * 100 */
 260
 261         int16_t         acceleration;   /* 18 m/s² * 16 */
 262         int16_t         speed;          /* 20 m/s * 16 */
 263         int16_t         height;         /* 22 m */
 264
 265         int32_t         ground_pres;    /* 24 average pres on pad */
 266
 267         int32_t         pad28;          /* 28 */
 268         /* 32 */
 269 };
 270
 271 /* #define AO_SEND_ALL_BARO */
 272
 273 #define AO_TELEMETRY_BARO               0x80
 274
 275 /*
 276  * This packet allows the full sampling rate baro
 277  * data to be captured over the RF link so that the
 278  * flight software can be tested using 'real' data.
 279  *
 280  * Along with this telemetry packet, the flight
 281  * code is modified to send full-rate telemetry all the time
 282  * and never send an RDF tone; this ensure that the full radio
 283  * link is available.
 284  */
 285 struct ao_telemetry_baro {
 286         uint16_t                                serial;         /*  0 */
 287         uint16_t                                tick;           /*  2 */
 288         uint8_t                                 type;           /*  4 */
 289         uint8_t                                 samples;        /*  5 number samples */
 290
 291         int16_t                                 baro[12];       /* 6 samples */
 292         /* 32 */
 293 };
 294
 295 union ao_telemetry_all {
 296         struct ao_telemetry_generic             generic;
 297         struct ao_telemetry_sensor              sensor;
 298         struct ao_telemetry_configuration       configuration;
 299         struct ao_telemetry_location            location;
 300         struct ao_telemetry_satellite           satellite;
 301         struct ao_telemetry_companion           companion;
 302         struct ao_telemetry_mega_sensor         mega_sensor;
 303         struct ao_telemetry_mega_data           mega_data;
 304         struct ao_telemetry_metrum_sensor       metrum_sensor;
 305         struct ao_telemetry_metrum_data         metrum_data;
 306         struct ao_telemetry_mini                mini;
 307         struct ao_telemetry_baro                baro;
 308 };
 309
 310 #define CC_TELEMETRY_HEADER     "TELEM"
 311
 312 /* "TELEM " 1 byte length 32 data bytes 1 rssi 1 status 1 checksum 1 null */
 313
 314 #define CC_TELEMETRY_BUFSIZE    (6 + (1 + 32 + 3) * 2 + 1)
 315
 316 int
 317 cc_telemetry_parse(const char *input_line, union ao_telemetry_all *telemetry);
 318
 319 uint8_t
 320 cc_telemetry_cksum(const union ao_telemetry_all *telemetry);
 321
 322 void
 323 cc_telemetry_unparse(const union ao_telemetry_all *telemetry, char output_line[CC_TELEMETRY_BUFSIZE]);
 324
 325 #endif