git.gag.com Git - fw/altos/blob - src/kernel/ao_telemetry.h

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