git.gag.com Git - fw/altos/blob - src/kernel/ao_report.c

   1 /*
   2  * Copyright © 2009 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 #include "ao.h"
  20 #include <ao_flight.h>
  21 #include <ao_sample.h>
  22
  23 #define BIT(i,x)           ((x) ? (1 << (i)) : 0)
  24 #define MORSE1(a)          (1 | BIT(3,a))
  25 #define MORSE2(a,b)        (2 | BIT(3,a) | BIT(4,b))
  26 #define MORSE3(a,b,c)      (3 | BIT(3,a) | BIT(4,b) | BIT(5,c))
  27 #define MORSE4(a,b,c,d)    (4 | BIT(3,a) | BIT(4,b) | BIT(5,c) | BIT(6,d))
  28 #define MORSE5(a,b,c,d,e)  (5 | BIT(3,a) | BIT(4,b) | BIT(5,c) | BIT(6,d) | BIT(7,e))
  29
  30 static const uint8_t flight_reports[] = {
  31         MORSE3(0,0,0),          /* startup, 'S' */
  32         MORSE2(0,0),            /* idle 'I' */
  33         MORSE4(0,1,1,0),        /* pad 'P' */
  34         MORSE4(1,0,0,0),        /* boost 'B' */
  35         MORSE4(0,0,1,0),        /* fast 'F' */
  36         MORSE4(1,0,1,0),        /* coast 'C' */
  37         MORSE3(1,0,0),          /* drogue 'D' */
  38         MORSE2(1,1),            /* main 'M' */
  39         MORSE4(0,1,0,0),        /* landed 'L' */
  40         MORSE4(1,0,0,1),        /* invalid 'X' */
  41 };
  42
  43 static enum ao_flight_state ao_report_state;
  44
  45 #if HAS_BEEP
  46 #define low(time)       ao_beep_for(AO_BEEP_LOW, time)
  47 #define mid(time)       ao_beep_for(AO_BEEP_MID, time)
  48 #define high(time)      ao_beep_for(AO_BEEP_HIGH, time)
  49 #else
  50 #ifndef AO_LED_LOW
  51 #define AO_LED_LOW      AO_LED_GREEN
  52 #endif
  53 #ifndef AO_LED_MID
  54 #define AO_LED_MID      AO_LED_RED
  55 #endif
  56
  57 #define low(time)       ao_led_for(AO_LED_LOW, time)
  58 #define mid(time)       ao_led_for(AO_LED_MID, time)
  59 #define high(time)      ao_led_for(AO_LED_MID|AO_LED_LOW, time)
  60 #endif
  61 #define pause(time)     ao_delay(time)
  62
  63 /*
  64  * Farnsworth spacing
  65  *
  66  * From: http://www.arrl.org/files/file/Technology/x9004008.pdf
  67  *
  68  *      c:      character rate in wpm
  69  *      s:      overall rate in wpm
  70  *      u:      unit rate (dit speed)
  71  *
  72  *      dit:                    u
  73  *      dah:                    3u
  74  *      intra-character-time:   u
  75  *
  76  *      u = 1.2/c
  77  *
  78  * Because our clock runs at 10ms, we'll round up to 70ms for u, which
  79  * is about 17wpm
  80  *
  81  *      Farnsworth adds space between characters and
  82  *      words:
  83  *           60 c - 37.2 s
  84  *      Ta = -------------
  85  *                sc
  86  *
  87  *           3 Ta
  88  *      Tc = ----
  89  *            19
  90  *
  91  *           7 Ta
  92  *      Tw = ----
  93  *            19
  94  *
  95  *      Ta = total delay to add to the characters (31 units)
  96  *           of a standard 50-unit "word", in seconds
  97  *
  98  *      Tc = period between characters, in seconds
  99  *
 100  *      Tw = period between words, in seconds
 101  *
 102  * We'll use Farnsworth spacing with c=18 and s=12:
 103  *
 104  *      u = 1.2/18 = 0.0667
 105  *
 106  *      Ta = (60 * 17 - 37.2 * 12) / (17 * 12) = 2.812
 107  *
 108  *      Tc = 3 * Ta / 19 = .444
 109  *
 110  *      Tw = 1.036
 111  *
 112  * Note that the values below are all reduced by 10ms; that's because
 113  * the timer always adds a tick to make sure the task actually sleeps
 114  * at least as long as the argument.
 115  */
 116
 117 static void
 118 ao_report_flight_state(void)
 119 {
 120         uint8_t r = flight_reports[ao_flight_state];
 121         uint8_t l = r & 7;
 122
 123         if (!r)
 124                 return;
 125         while (l--) {
 126                 if (r & 8)
 127                         mid(AO_MS_TO_TICKS(200));
 128                 else
 129                         mid(AO_MS_TO_TICKS(60));
 130                 pause(AO_MS_TO_TICKS(60));
 131                 r >>= 1;
 132         }
 133         pause(AO_MS_TO_TICKS(360));
 134 }
 135
 136 static void
 137 ao_report_digit(uint8_t digit)
 138 {
 139         if (!digit) {
 140                 mid(AO_MS_TO_TICKS(500));
 141                 pause(AO_MS_TO_TICKS(200));
 142         } else {
 143                 while (digit--) {
 144                         mid(AO_MS_TO_TICKS(200));
 145                         pause(AO_MS_TO_TICKS(200));
 146                 }
 147         }
 148         pause(AO_MS_TO_TICKS(300));
 149 }
 150
 151 static void
 152 ao_report_number(int32_t n)
 153 {
 154         uint8_t digits[10];
 155         uint8_t ndigits, i;
 156
 157         if (n < 0)
 158                 n = 0;
 159         ndigits = 0;
 160         do {
 161                 digits[ndigits++] = (uint8_t) (n % 10);
 162                 n /= 10;
 163         } while (n);
 164
 165         i = ndigits;
 166         do
 167                 ao_report_digit(digits[--i]);
 168         while (i != 0);
 169 }
 170
 171 #ifdef HAS_BARO
 172 static void
 173 ao_report_altitude(void)
 174 {
 175         alt_t max_h = ao_max_height;
 176         if (ao_config.report_feet) {
 177                 max_h = max_h * 39 / 12;
 178                 /* report a leading zero to distinguish */
 179                 if (max_h)
 180                         ao_report_digit(0);
 181         }
 182         ao_report_number(max_h);
 183 }
 184 #endif
 185
 186 #if HAS_BATTERY_REPORT
 187 static void
 188 ao_report_battery(void)
 189 {
 190         struct ao_data packet;
 191         for (;;) {
 192                 ao_data_get(&packet);
 193                 if (packet.adc.v_batt != 0)
 194                         break;
 195                 ao_sleep(&ao_sample_data);
 196         }
 197         ao_report_number(ao_battery_decivolt(packet.adc.v_batt));
 198 }
 199 #endif
 200
 201 #if HAS_IGNITE_REPORT
 202 #if HAS_IGNITE
 203 static uint8_t
 204 ao_report_igniter_ready(enum ao_igniter igniter)
 205 {
 206         return ao_igniter_status(igniter) == ao_igniter_ready ? 1 : 0;
 207 }
 208
 209 uint8_t
 210 ao_report_igniter(void)
 211 {
 212         return (uint8_t) (ao_report_igniter_ready(ao_igniter_drogue) |
 213                           (ao_report_igniter_ready(ao_igniter_main) << 1));
 214 }
 215 #endif
 216
 217 static void
 218 ao_report_continuity(void)
 219 {
 220         uint8_t c;
 221 #if HAS_IGNITE
 222         c = ao_report_igniter();
 223         if (c) {
 224                 while (c--) {
 225                         high(AO_MS_TO_TICKS(25));
 226                         pause(AO_MS_TO_TICKS(100));
 227                 }
 228         } else {
 229                 c = 5;
 230                 while (c--) {
 231                         high(AO_MS_TO_TICKS(20));
 232                         low(AO_MS_TO_TICKS(20));
 233                 }
 234         }
 235 #endif
 236 #if AO_PYRO_NUM
 237 #if HAS_IGNITE
 238         pause(AO_MS_TO_TICKS(250));
 239 #endif
 240         for(c = 0; c < AO_PYRO_NUM; c++) {
 241                 enum ao_igniter_status  status = ao_pyro_status(c);
 242                 if (status == ao_igniter_ready)
 243                         mid(AO_MS_TO_TICKS(25));
 244                 else
 245                         low(AO_MS_TO_TICKS(25));
 246                 pause(AO_MS_TO_TICKS(200));
 247         }
 248 #endif
 249 #if HAS_LOG
 250         if (ao_log_full()) {
 251                 pause(AO_MS_TO_TICKS(100));
 252                 c = 2;
 253                 while (c--) {
 254                         low(AO_MS_TO_TICKS(100));
 255                         mid(AO_MS_TO_TICKS(100));
 256                         high(AO_MS_TO_TICKS(100));
 257                         mid(AO_MS_TO_TICKS(100));
 258                 }
 259         }
 260 #endif
 261 }
 262 #endif
 263
 264 static void
 265 ao_report(void)
 266 {
 267         for(;;) {
 268                 ao_report_state = ao_flight_state;
 269 #if HAS_BATTERY_REPORT
 270                 if (ao_report_state == ao_flight_startup)
 271                         ao_report_battery();
 272                 else
 273 #endif
 274                         ao_report_flight_state();
 275 #if HAS_SENSOR_ERRORS
 276                 if (ao_report_state == ao_flight_invalid && ao_sensor_errors)
 277                         ao_report_number(ao_sensor_errors);
 278 #endif
 279
 280                 if (ao_report_state == ao_flight_landed) {
 281 #if HAS_BARO
 282                         ao_report_altitude();
 283 #endif
 284 #if HAS_FLIGHT
 285                         ao_delay(AO_SEC_TO_TICKS(5));
 286                         continue;
 287 #endif
 288                 }
 289 #if HAS_IGNITE_REPORT
 290                 if (ao_report_state == ao_flight_idle)
 291                         ao_report_continuity();
 292                 while (ao_flight_state == ao_flight_pad) {
 293                         uint8_t c;
 294                         ao_report_continuity();
 295                         c = 50;
 296                         while (c-- && ao_flight_state == ao_flight_pad)
 297                                 pause(AO_MS_TO_TICKS(100));
 298                 }
 299 #endif
 300 #if HAS_PAD_REPORT
 301                 while (ao_flight_state == ao_flight_pad) {
 302                         uint8_t c;
 303                         ao_report_flight_state();
 304                         c = 50;
 305                         while (c-- && ao_flight_state == ao_flight_pad)
 306                                 pause(AO_MS_TO_TICKS(100));
 307                 }
 308 #endif
 309                 while (ao_report_state == ao_flight_state)
 310                         ao_sleep(&ao_flight_state);
 311         }
 312 }
 313
 314 static struct ao_task ao_report_task;
 315
 316 void
 317 ao_report_init(void)
 318 {
 319         ao_add_task(&ao_report_task, ao_report, "report");
 320 }